Package tuwien.auto.calimero.tools

Class ProgMode

java.lang.Object
tuwien.auto.calimero.tools.ProgMode
All Implemented Interfaces:
Runnable
public class ProgMode extends Object implements Runnable
ProgMode lists the current KNX devices in programming mode, and allows to set the programming mode of a device. The tool supports network access using KNXnet/IP, KNX IP, USB, FT1.2, and TP-UART.

Run the tool by using either main(String[]) or Runnable.run().

  • Constructor Details

    • ProgMode

      public ProgMode(String[] args)
      Creates a new ProgMode object using the supplied arguments.
      Parameters:
      args - options for the 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 ProgMode tool from the command line.

      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, use 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
      • --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
      • --medium -m id  KNX medium [tp1|p110|rf|knxip] (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
      • --local  use local device management
      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.

      Supported commands (the device address is not needed with local device management):

      • on device address   switch programming mode on
      • off device address   switch programming mode off
      Parameters:
      args - command line arguments for the tool

    • run

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

    • devicesInProgMode

      protected void devicesInProgMode(tuwien.auto.calimero.IndividualAddress... devices)

    • onCompletion

      protected void onCompletion(Exception thrown, boolean canceled)
      Called by this tool on completion.
      Parameters:
      thrown - the thrown exception if operation completed due to a raised exception, null otherwise
      canceled - whether the operation got canceled before its planned end