Package tuwien.auto.calimero.tools

Class PropClient

java.lang.Object
tuwien.auto.calimero.tools.PropClient
All Implemented Interfaces:
Runnable
public class PropClient extends Object implements Runnable
A tool for Calimero showing features of the PropertyClient used for KNX property access.

PropClient is a console based tool implementation for reading and writing KNX properties. It supports network access using a KNXnet/IP, USB, or FT1.2 connection. To start the PropClient, invoke the main-method of this class. Take a look at the command line options to configure the tool with the desired communication settings.

The main part of this tool implementation interacts with the PropertyClient interface, which offers high level access to KNX property information. It also shows creation of the PropertyAdapter, necessary for a property client to work. All queried property values, as well as occurring problems are written to System.out .

  • Constructor Details

    • PropClient

      public PropClient(String[] args)
      Constructs a new PropClient.

      Parameters:
      args - options for the property client tool, see main(String[])
      Throws:
      tuwien.auto.calimero.KNXIllegalArgumentException - on missing or wrong formatted option value

  • Method Details

    • main

      public static void main(String... args)
      Entry point for running the PropClient.

      An IP host or port identifier has to be supplied to specify the endpoint for the 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 for the property client:

      • --help -h show help message
      • --version show tool/library version and exit
      • --local -l local device management
      • --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 KNX device
      Parameters:
      args - command line options for property client

    • run

      public void run()
      Specified by:
      run in interface Runnable