tuwien.auto.calimero.tools.Property Maven / Gradle / Ivy
Show all versions of calimero-tools 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.tools;
import static java.util.stream.Collectors.joining;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import tuwien.auto.calimero.CloseEvent;
import tuwien.auto.calimero.DataUnitBuilder;
import tuwien.auto.calimero.IndividualAddress;
import tuwien.auto.calimero.KNXException;
import tuwien.auto.calimero.KNXIllegalArgumentException;
import tuwien.auto.calimero.Settings;
import tuwien.auto.calimero.dptxlator.DPTXlator;
import tuwien.auto.calimero.knxnetip.KNXnetIPConnection;
import tuwien.auto.calimero.link.KNXNetworkLink;
import tuwien.auto.calimero.link.KNXNetworkLinkFT12;
import tuwien.auto.calimero.link.KNXNetworkLinkIP;
import tuwien.auto.calimero.link.KNXNetworkLinkTpuart;
import tuwien.auto.calimero.link.KNXNetworkLinkUsb;
import tuwien.auto.calimero.link.medium.KNXMediumSettings;
import tuwien.auto.calimero.link.medium.TPSettings;
import tuwien.auto.calimero.mgmt.Description;
import tuwien.auto.calimero.mgmt.LocalDeviceManagementUsb;
import tuwien.auto.calimero.mgmt.LocalDeviceMgmtAdapter;
import tuwien.auto.calimero.mgmt.PropertyAdapter;
import tuwien.auto.calimero.mgmt.PropertyClient;
import tuwien.auto.calimero.mgmt.PropertyClient.PropertyKey;
import tuwien.auto.calimero.mgmt.PropertyClient.XmlPropertyDefinitions;
import tuwien.auto.calimero.mgmt.RemotePropertyServiceAdapter;
import tuwien.auto.calimero.serial.usb.UsbConnection;
import tuwien.auto.calimero.xml.KNXMLException;
import tuwien.auto.calimero.xml.XmlInputFactory;
import tuwien.auto.calimero.xml.XmlReader;
/**
* A tool for Calimero showing features of the {@link PropertyClient} used for KNX property access.
*
* Property is a {@link Runnable} tool implementation to set or get a KNX property from an Interface
* Object Server (IOS), get its KNX property description, or scan the KNX descriptions available. It
* supports network access using a KNXnet/IP, KNX IP, USB, FT1.2, or TP-UART connection.
* The tool implementation mainly interacts with {@link PropertyClient}, which offers high-level
* access to KNX property information. It also shows creation of the {@link PropertyAdapter},
* necessary for a property client to work. All queried property values, as well as occurring
* problems are written to System.out.
*
* When starting this tool from the console, the main-method of this class is invoked,
* otherwise use it in the context appropriate to {@link Runnable}. Take a look at the command line
* options to configure the tool with the appropriate communication settings.
*
* @author B. Malinowsky
*/
public class Property implements Runnable
{
private static final String tool = "Property";
private static final String sep = System.getProperty("line.separator");
static Logger out = LoggerFactory.getLogger("calimero.tools");
/** Contains tool options after parsing command line. */
protected final Map options = new HashMap<>();
/** The used property client. */
protected PropertyClient pc;
private KNXNetworkLink link;
private Map definitions;
private final Thread interruptOnClose;
/**
* Constructs a new Property object.
*
*
* @param args options for the property tool, see {@link #main(String[])}
* @throws KNXIllegalArgumentException on missing or wrong formatted option value
*/
public Property(final String[] args)
{
interruptOnClose = Thread.currentThread();
try {
parseOptions(args);
}
catch (final KNXIllegalArgumentException e) {
throw e;
}
catch (final RuntimeException e) {
throw new KNXIllegalArgumentException(e.getMessage(), e);
}
}
/**
* Entry point for running the Property tool from the console.
*
* A communication device, host, or port identifier has to be supplied to specify the endpoint
* for KNX network access.
* To show the usage message of this tool on the console, supply the command line option --help
* (or -h).
* Command line options are treated case sensitive. Available options are:
*
* --help -h show help message--version show tool/library version and exit--verbose -v enable verbose status output--local -l local device management (default)--remote -r KNX addr remote property service--definitions -d file use property definition file--localhost id local IP/host name--localport number local UDP port (default system assigned)--port -p number UDP port on host (default 3671)--nat -n enable Network Address Translation--ft12 -f use FT1.2 serial communication--usb -u use KNX USB communication--tpuart use TP-UART communication
* For local device management these options are available:
*
* --emulatewriteenable -e check write-enable of a property
* For remote property service these options are available:
*
* --medium -m id KNX medium [tp1|p110|knxip|rf] (defaults to tp1)--domain address domain address on open KNX medium (PL or RF)--knx-address -k KNX address KNX device address of local endpoint--connect -c connection oriented mode--authorize -a key authorize key to access the KNX device
* Use one of the following commands for property access, with object-idx being the
* interface object index, and pid the KNX property identifier:
*
* get object-idx pid [start-idx elements] get the property value(s)set object-idx pid [start-idx] string-value set the property string-formatted valueset object-idx pid start-idx elements [\"0x\"|\"0\"|\"b\"]data set the property datadesc object-idx pid get the property description of the property IDdesc object-idx "i" prop-idx get the property description of the property indexscan [object-idx] list interface object type descriptions (of the
* indexed interface object)scan [object-idx] "all" list all property descriptions (of the
* indexed interface object)? show command help
* The --knx-address option is only necessary if an access protocol is selected
* that directly communicates with the KNX network, i.e., KNX IP or TP-UART. The selected KNX
* individual address shall be unique in a network, and the subnetwork address (area and line)
* should be set to match the network configuration.
*
* @param args command line options for the property tool
*/
public static void main(final String[] args)
{
try {
new Property(args).run();
}
catch (final Throwable t) {
out.error("parsing option", t);
}
}
@Override
public void run()
{
Exception thrown = null;
boolean canceled = false;
try {
if (options.isEmpty()) {
out(tool + " - Access KNX properties");
showVersion();
out("Type --help for help message");
return;
}
if (options.containsKey("help")) {
showUsage();
return;
}
if (options.containsKey("version")) {
showVersion();
return;
}
final PropertyAdapter adapter = createAdapter();
if (options.containsKey("reset") && adapter instanceof LocalDeviceMgmtAdapter) {
out("send local device management reset request to " + options.get("host") + ":" + options.get("port"));
final LocalDeviceMgmtAdapter ldm = (LocalDeviceMgmtAdapter) adapter;
ldm.reset();
while (ldm.isOpen())
Thread.sleep(1000);
}
pc = new PropertyClient(adapter);
String resource = "";
try {
// check if user supplied a XML resource with property definitions
if (options.containsKey("definitions")) {
resource = (String) options.get("definitions");
pc.addDefinitions(new XmlPropertyDefinitions().load(resource));
}
else {
resource = "/properties.xml";
try (InputStream is = Property.class.getResourceAsStream(resource);
XmlReader r = XmlInputFactory.newInstance().createXMLStreamReader(is)) {
pc.addDefinitions(new XmlPropertyDefinitions().load(r));
}
}
definitions = pc.getDefinitions();
}
catch (IOException | KNXMLException e) {
out.error("loading definitions from " + resource + " failed", e);
}
// run the user command
runCommand((String[]) options.get("command"));
}
catch (KNXException | RuntimeException e) {
thrown = e;
}
catch (final InterruptedException e) {
canceled = true;
Thread.currentThread().interrupt();
}
finally {
if (pc != null)
pc.close();
if (link != null)
link.close();
onCompletion(thrown, canceled);
}
}
private void adapterClosed(final CloseEvent e)
{
out("connection closed (" + e.getReason() + ")");
if (e.getInitiator() != CloseEvent.USER_REQUEST)
interruptOnClose.interrupt();
}
/**
* Runs a single command.
*
* @param cmd the command to execute together with its parameters
* @throws InterruptedException on thread interrupt
*/
protected void runCommand(final String... cmd) throws InterruptedException
{
if (cmd == null)
return;
try {
final String what = cmd[0];
if ("get".equals(what))
getProperty(cmd);
else if ("set".equals(what))
setProperty(cmd);
else if ("scan".equals(what))
scanProperties(cmd);
else if ("desc".equals(what))
getDescription(cmd);
else if ("?".equals(what))
showCommandList();
else
out("unknown command, type ? for help");
}
catch (final NumberFormatException e) {
out.error("invalid number (" + e.getMessage() + ")");
}
catch (final KNXException | RuntimeException e) {
out.error(e.getMessage());
}
}
/**
* Invoked on receiving a property description.
*
* @param d the KNX property description
*/
protected void onDescription(final Description d)
{
final StringBuilder buf = new StringBuilder();
buf.append("OI ").append(alignRight(d.getObjectIndex(), 2));
buf.append(", PI ").append(alignRight(d.getPropIndex(), 2)).append(" |");
buf.append(" OT ").append(alignRight(d.getObjectType(), 3));
buf.append(", PID ").append(alignRight(d.getPID(), 3));
buf.append(" | ");
tuwien.auto.calimero.mgmt.PropertyClient.Property p = getPropertyDef(d.getObjectType(),
d.getPID());
if (p == null)
p = getPropertyDef(PropertyKey.GLOBAL_OBJTYPE, d.getPID());
if (p != null) {
buf.append(p.getName());
while (buf.length() < 65)
buf.append(' ');
buf.append(" (");
buf.append(p.getPIDName());
buf.append(")");
}
else
buf.append(new String(new char[33]).replace('\0', ' ')).append("(n/a)");
final String pdtDef = p != null ? Integer.toString(p.getPDT()) : "-";
buf.append(", PDT " + (d.getPDT() == -1 ? pdtDef : Integer.toString(d.getPDT())));
buf.append(", curr. elems " + d.getCurrentElements());
buf.append(", max. " + d.getMaxElements());
buf.append(", r/w access " + d.getReadLevel() + "/" + d.getWriteLevel());
buf.append(d.isWriteEnabled() ? ", w.enabled" : ", r.only");
System.out.println(buf.toString());
}
/**
* Invoked on receiving a property value.
*
* @param idx the object index
* @param pid the property ID
* @param value the property values
* @param raw list with the raw property data, list size == property elements
*/
protected void onPropertyValue(final int idx, final int pid, final String value, final List raw)
{
final String rawValue = raw.stream().map(e -> DataUnitBuilder.toHex(e, "")).collect(joining(", ", " (", ")"));
System.out.println(value + rawValue);
}
/**
* Called by this tool on completion.
*
* @param thrown the thrown exception if operation completed due to a raised exception,
* null otherwise
* @param canceled whether the operation got canceled before its planned end
*/
protected void onCompletion(final Exception thrown, final boolean canceled)
{
if (canceled)
out("reading property canceled");
if (thrown != null)
out.error("on completion", thrown);
}
/** @return the network link used by this tool */
protected KNXNetworkLink link()
{
return link;
}
/**
* Creates the property adapter to be used with the property client depending on the supplied
* user options.
*
* There are two types of property adapters. One is for local device management to access KNX
* properties of the connected interface, specifically, KNXnet/IP and KNX USB devices. The other
* type uses remote property services to access KNX properties of a KNX device over the KNX bus.
* If a remote property service adapter is requested, the required KNX network link to access
* the KNX network is automatically created.
*
* @return the created adapter
* @throws KNXException on adapter creation problem
* @throws InterruptedException on interrupted thread
*/
private PropertyAdapter createAdapter() throws KNXException, InterruptedException
{
final String host = (String) options.get("host");
// decide what type of adapter to create
if (options.containsKey("local")) {
if (options.containsKey("usb"))
return createUsbAdapter(host);
// create local and remote socket address for use in adapter
return createLocalDMAdapter(host);
}
return createRemoteAdapter(host);
}
/**
* Creates a KNXnet/IP local device management adapter.
*
* @param host remote host
* @return local device management adapter
* @throws KNXException on adapter creation problem
* @throws InterruptedException on interrupted thread
*/
private PropertyAdapter createLocalDMAdapter(final String host) throws KNXException,
InterruptedException
{
final InetSocketAddress local = Main.createLocalSocket(
(InetAddress) options.get("localhost"), (Integer) options.get("localport"));
return new LocalDeviceMgmtAdapter(local, new InetSocketAddress(Main.parseHost(host),
(Integer) options.get("port")), options.containsKey("nat"), this::adapterClosed,
options.containsKey("emulatewriteenable"));
}
/**
* Creates a local device management adapter for a KNX USB interface.
*/
private PropertyAdapter createUsbAdapter(final String device) throws KNXException,
InterruptedException
{
final UsbConnection usb = new UsbConnection(device);
return new LocalDeviceManagementUsb(usb, this::adapterClosed, options.containsKey("emulatewriteenable"));
}
/**
* Creates the KNX network link and remote property service adapter for one device in the KNX
* network. The adapter uses a KNX network link for access, also is created by this method.
*
* @param host remote host
* @return remote property service adapter
* @throws KNXException on adapter creation problem
* @throws InterruptedException on interrupted thread
*/
private PropertyAdapter createRemoteAdapter(final String host) throws KNXException,
InterruptedException
{
final KNXMediumSettings medium = (KNXMediumSettings) options.get("medium");
if (options.containsKey("ft12")) {
// create FT1.2 network link
try {
link = new KNXNetworkLinkFT12(Integer.parseInt(host), medium);
}
catch (final NumberFormatException e) {
link = new KNXNetworkLinkFT12(host, medium);
}
}
else if (options.containsKey("usb")) {
// create KNX USB HID network link
link = new KNXNetworkLinkUsb(host, medium);
}
else if (options.containsKey("tpuart")) {
// create TP-UART link
final IndividualAddress device = (IndividualAddress) options.get("knx-address");
medium.setDeviceAddress(device);
link = new KNXNetworkLinkTpuart(host, medium, Collections.emptyList());
}
else {
final InetSocketAddress local = Main.createLocalSocket((InetAddress) options.get("localhost"),
(Integer) options.get("localport"));
final InetAddress addr = Main.parseHost(host);
if (addr.isMulticastAddress())
link = KNXNetworkLinkIP.newRoutingLink(local.getAddress(), addr, medium);
else {
final InetSocketAddress remote = new InetSocketAddress(addr, (Integer) options.get("port"));
link = KNXNetworkLinkIP.newTunnelingLink(local, remote, options.containsKey("nat"), medium);
}
}
final IndividualAddress remote = (IndividualAddress) options.get("remote");
// if an authorization key was supplied, the adapter uses
// connection oriented mode and tries to authenticate
final byte[] authKey = (byte[]) options.get("authorize");
if (authKey != null) {
final RemotePropertyServiceAdapter adapter = new RemotePropertyServiceAdapter(link, remote, this::adapterClosed, authKey);
out.info("{} granted access level {}", remote, adapter.accessLevel());
return adapter;
}
return new RemotePropertyServiceAdapter(link, remote, this::adapterClosed, options.containsKey("connect"));
}
private static String alignRight(final int value, final int width)
{
return String.format("%1$" + width + "s", Integer.toString(value));
}
private tuwien.auto.calimero.mgmt.PropertyClient.Property getPropertyDef(final int objType,
final int pid)
{
if (definitions == null)
return null;
return definitions.get(new PropertyClient.PropertyKey(objType, pid));
}
private void parseOptions(final String[] args)
{
if (args.length == 0)
return;
// add defaults
options.put("port", KNXnetIPConnection.DEFAULT_PORT);
options.put("medium", TPSettings.TP1);
// default subnetwork address for TP1 and unregistered device
options.put("knx-address", new IndividualAddress(0, 0x02, 0xff));
int i = 0;
for (; i < args.length; i++) {
final String arg = args[i];
if (Main.isOption(arg, "help", "h")) {
options.put("help", null);
return;
}
if (Main.isOption(arg, "version", null)) {
options.put("version", null);
return;
}
if (Main.isOption(arg, "local", "l"))
options.put("local", null);
else if (Main.isOption(arg, "remote", "r"))
options.put("remote", Main.getAddress(args[++i]));
else if (Main.isOption(arg, "definitions", "d"))
options.put("definitions", args[++i]);
else if (Main.isOption(arg, "verbose", "v"))
options.put("verbose", null);
else if (Main.isOption(arg, "localhost", null))
options.put("localhost", Main.parseHost(args[++i]));
else if (Main.isOption(arg, "localport", null))
options.put("localport", Integer.decode(args[++i]));
else if (Main.isOption(arg, "port", "p"))
options.put("port", Integer.decode(args[++i]));
else if (Main.isOption(arg, "nat", "n"))
options.put("nat", null);
else if (Main.isOption(arg, "ft12", "f"))
options.put("ft12", null);
else if (Main.isOption(arg, "usb", "u"))
options.put("usb", null);
else if (Main.isOption(arg, "tpuart", null))
options.put("tpuart", null);
else if (Main.isOption(arg, "medium", "m"))
options.put("medium", Main.getMedium(args[++i]));
else if (Main.isOption(arg, "domain", null))
options.put("domain", Long.decode(args[++i]));
else if (Main.isOption(arg, "knx-address", "k"))
options.put("knx-address", Main.getAddress(args[++i]));
else if (Main.isOption(arg, "emulatewriteenable", "e"))
options.put("emulatewriteenable", null);
else if (Main.isOption(arg, "connect", "c"))
options.put("connect", null);
else if (Main.isOption(arg, "authorize", "a"))
options.put("authorize", getAuthorizeKey(args[++i]));
else if (arg.equals("reset"))
options.put("reset", null);
else if (arg.equals("get") || arg.equals("set") || arg.equals("desc") || arg.equals("scan")) {
final List cmd = new ArrayList<>();
cmd.add(arg);
while (addOptionIfInteger(cmd, args, i + 1))
++i;
if (arg.equals("desc") && i + 1 < args.length && args[i + 1].equals("i")) {
cmd.add(args[++i]);
cmd.add(args[++i]);
}
if (arg.equals("scan") && i + 1 < args.length && args[i + 1].equals("all"))
cmd.add(args[++i]);
options.put("command", cmd.toArray(new String[0]));
}
else if (arg.equals("?"))
options.put("command", new String[] { "?" });
else if (!options.containsKey("host"))
options.put("host", arg);
else
throw new KNXIllegalArgumentException("unknown option " + arg);
}
if (!options.containsKey("remote"))
options.put("local", null);
if (!options.containsKey("host"))
throw new KNXIllegalArgumentException("no communication device/host specified");
if (options.containsKey("ft12") && !options.containsKey("remote"))
throw new KNXIllegalArgumentException("--remote option is mandatory with --ft12");
Main.setDomainAddress(options);
}
//
// utility methods
//
private static boolean addOptionIfInteger(final List cmd, final String[] args, final int index)
{
if (index < args.length) try {
final String arg = args[index];
Integer.decode(arg);
return cmd.add(arg);
}
catch (final NumberFormatException expected) {}
return false;
}
private void getProperty(final String[] args) throws KNXException, InterruptedException
{
if (args.length == 2 && args[1].equals("?"))
out("get object-idx pid [start-idx elements]");
else if (args.length == 3 || args.length == 5) {
final int oi = toInt(args[1]);
final int pid = toInt(args[2]);
// std.frame: max ASDU = 14 -> actual data = 10, we assume max. PDT size of 4 bytes -> max 2 elements
final int maxElements = 2;
String s = "";
final List raw = new ArrayList<>();
try {
if (args.length == 3) {
final DPTXlator x = pc.getPropertyTranslated(oi, pid, 1, 1);
s = x.getValue();
raw.add(x.getData());
}
else {
final int start = toInt(args[3]);
final int elements = toInt(args[4]);
for (int i = start; i <= elements; i += maxElements) {
final int min = Math.min(maxElements, (elements - i + 1));
final DPTXlator translator = pc.getPropertyTranslated(oi, pid, i, min);
final byte[] data = translator.getData();
final int size = data.length / min;
for (int from = 0; from < data.length; from += size)
raw.add(Arrays.copyOfRange(data, from, from + size));
final String[] allValues = translator.getAllValues();
if (!s.isEmpty())
s += ", ";
s += Arrays.asList(allValues).stream().collect(Collectors.joining(", "));
}
}
}
catch (final KNXException e) {
s = "";
if (args.length == 3) {
final byte[] data = pc.getProperty(oi, pid, 1, 1);
s = "0x" + DataUnitBuilder.toHex(data, "");
raw.add(data);
}
else {
final int start = toInt(args[3]);
final int elements = toInt(args[4]);
for (int i = start; i <= elements; i += maxElements) {
final int min = Math.min(maxElements, (elements - i + 1));
final byte[] data = pc.getProperty(oi, pid, i, min);
final String hex = DataUnitBuilder.toHex(data, "");
final int chars = hex.length() / min;
for (int k = 0; k < min; ++k)
s += "0x" + hex.substring(k * chars, (k + 1) * chars) + " ";
final int size = data.length / min;
for (int from = 0; from < data.length; from += size)
raw.add(Arrays.copyOfRange(data, from, from + size));
}
s = s.trim();
}
}
onPropertyValue(oi, pid, s, raw);
}
else
out("sorry, wrong number of arguments");
}
private void getDescription(final String[] args) throws KNXException, InterruptedException
{
if (args.length == 3)
onDescription(pc.getDescription(toInt(args[1]), toInt(args[2])));
else if (args.length == 4 && args[2].equals("i"))
onDescription(pc.getDescriptionByIndex(toInt(args[1]), toInt(args[3])));
else if (args.length == 2 && args[1].equals("?"))
printHelp("desc object-idx pid" + sep + "desc object-idx \"i\" prop-idx");
else
out("sorry, wrong number of arguments");
}
private void setProperty(final String[] args) throws KNXException, InterruptedException
{
if (args.length == 2 && args[1].equals("?")) {
printHelp("set object-idx pid [start-idx] string-value" + sep
+ "set object-idx pid start-idx elements [\"0x\"|\"0\"|\"b\"]data" + sep
+ "(use hexadecimal format for more than 8 byte data or leading zeros)");
return;
}
if (args.length < 4 || args.length > 6) {
out("sorry, wrong number of arguments");
return;
}
final int cnt = args.length;
final int oi = toInt(args[1]);
final int pid = toInt(args[2]);
if (cnt == 4)
pc.setProperty(oi, pid, 1, args[3]);
else if (cnt == 5)
pc.setProperty(oi, pid, toInt(args[3]), args[4]);
else {
final int start = toInt(args[3]);
final int elements = toInt(args[4]);
final byte[] data = toByteArray(args[5]);
final int typeSize = data.length / elements;
if (typeSize == 0)
throw new KNXIllegalArgumentException(String.format(
"property data %s cannot be split into %d elements (type size 0)", args[5], elements));
final int usableAsdu = 14 - 4; // std. frame
final int maxLength = usableAsdu / typeSize * typeSize;
for (int i = 0; i < data.length; i += maxLength) {
final int len = Math.min(maxLength, (data.length - i));
pc.setProperty(oi, pid, start + i / typeSize, len / typeSize, Arrays.copyOfRange(data, i, i + len));
}
}
}
private void scanProperties(final String[] args) throws KNXException, InterruptedException
{
System.out.println("Object Index (OI), Property Index (PI), Object Type (OT), Property ID (PID)");
final int cnt = args.length;
if (cnt == 1)
pc.scanProperties(false, this::onDescription);
else if (cnt == 2) {
if (args[1].equals("all"))
pc.scanProperties(true, this::onDescription);
else if (args[1].equals("?"))
printHelp("scan [object-idx] [\"all\" for all object properties]");
else
pc.scanProperties(toInt(args[1]), false, this::onDescription);
}
else if (cnt == 3 && args[2].equals("all"))
pc.scanProperties(toInt(args[1]), true, this::onDescription);
else
out("sorry, wrong number of arguments");
}
private static void showCommandList()
{
final StringBuilder buf = new StringBuilder();
buf.append("commands: get | set | desc | scan (append ? for help)" + sep);
buf.append("get - read property value(s)" + sep);
buf.append("set - write property value(s)" + sep);
buf.append("desc - read one property description" + sep);
buf.append("scan - read property descriptions");
out(buf.toString());
}
private static void printHelp(final String help)
{
out(help);
}
private static void showUsage()
{
final StringBuilder sb = new StringBuilder();
sb.append("Usage: ").append(tool).append(" [options] ").append(sep);
sb.append("Options:").append(sep);
sb.append(" --help -h show this help message").append(sep);
sb.append(" --version show tool/library version and exit").append(sep);
sb.append(" --verbose -v enable verbose status output").append(sep);
sb.append(" --local -l local device management").append(sep);
sb.append(" --remote -r remote property service").append(sep);
sb.append(" --definitions -d use property definition file").append(sep);
sb.append(" --localhost local IP/host name").append(sep);
sb.append(" --localport local UDP port (default system assigned)")
.append(sep);
sb.append(" --port -p UDP port on (default ")
.append(KNXnetIPConnection.DEFAULT_PORT).append(")").append(sep);
sb.append(" --nat -n enable Network Address Translation").append(sep);
sb.append(" --ft12 -f use FT1.2 serial communication").append(sep);
sb.append(" --usb -u use KNX USB communication").append(sep);
sb.append(" --tpuart use TP-UART communication").append(sep);
sb.append("Options for local device management mode only:").append(sep);
sb.append(" --emulatewriteenable -e check write-enable of a property").append(sep);
sb.append("Options for remote property service mode only:").append(sep);
sb.append(" --medium -m KNX medium [tp1|p110|knxip|rf] (default tp1)").append(sep);
sb.append(" --domain domain address on KNX PL/RF medium (defaults to broadcast domain)")
.append(sep);
sb.append(" --connect -c connection oriented mode").append(sep);
sb.append(" --authorize -a authorize key to access KNX device").append(sep);
sb.append("Available commands:").append(sep);
sb.append(" get [ ] get the property value(s)")
.append(sep);
sb.append(" set [start-idx] "
+ "set the formatted property value (according to PDT)").append(sep);
sb.append(" set [\"0x\"|\"0\"|\"b\"] "
+ "set the property data").append(sep);
sb.append(" desc "
+ "get the property description of the property ID").append(sep);
sb.append(" desc \"i\" "
+ "get the property description of the property index").append(sep);
sb.append(" scan []"
+ " list interface object type descriptions").append(sep);
sb.append(" scan [] \"all\" list all property descriptions")
.append(sep);
sb.append(" ? show command help").append(sep);
out(sb.toString());
}
//
// utility methods
//
private static void showVersion()
{
out(Settings.getLibraryHeader(false));
}
private static byte[] getAuthorizeKey(final String key)
{
final long value = Long.decode(key).longValue();
if (value < 0 || value > 0xFFFFFFFFL)
throw new KNXIllegalArgumentException("invalid authorize key");
return new byte[] { (byte) (value >> 24), (byte) (value >> 16), (byte) (value >> 8), (byte) value };
}
private static int toInt(final String number)
{
return Integer.decode(number).intValue();
}
private static byte[] toByteArray(final String s)
{
// use of BigXXX equivalent is a bit awkward, for now this is sufficient ...
long l;
if (s.startsWith("0x") || s.startsWith("0X")) {
final byte[] d = new byte[(s.length() - 1) / 2];
int k = (s.length() & 0x01) != 0 ? 3 : 4;
for (int i = 2; i < s.length(); i = k, k += 2)
d[(i - 1) / 2] = (byte) Integer.parseInt(s.substring(i, k), 16);
return d;
}
else if (s.length() > 1 && s.startsWith("0"))
l = Long.parseLong(s, 8);
else if (s.startsWith("b"))
l = Long.parseLong(s.substring(1), 2);
else
l = Long.parseLong(s);
int i = 0;
for (long test = l; test != 0; test /= 0x100)
++i;
final byte[] d = new byte[i == 0 ? 1 : i];
for (; i-- > 0; l /= 0x100)
d[i] = (byte) (l & 0xff);
return d;
}
static void out(final String s)
{
System.out.println(s);
}
}