Skip to content

DCC-EX interface

$object.dccexinterface:description$

Properties

id

Unique object identifier. Each object in Traintastic has a globally unique id that can be used in scripts (see world.get_object).

input_channels

$object.interface.input_channels:description$

name

Interface name

online

true if interface is online, false otherwise. Read status for more information.

output_channels

Supported output channels, a table containing output channel values.

status

Interface status object.

Methods

get_input([channel,] address)

$object.interface.get_input:description$

Parameters:

  • channel
    $object.interface.get_input.parameter.channel:description$

  • address
    $object.interface.get_input.parameter.address:description$

Return values
$object.interface.get_input:return_values$

get_output(channel, address)

Get an output object.

Parameters:

  • channel
    Output channel, a Output channel value.

  • address
    Output address, valid range depends on channel.

Return values
Single output, Pair output or Aspect output object depending on channel or nil if channel/address combination is invalid.