Skip to content

LocoNet interface

Interface for communicating with a LocoNet network.

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.

imm_packet(dcc_packet [, repeat = 2])

Request the LocoNet command station to send a DCC packet to the track (OPC_IMM_PACKET).

Use this with caution!

These messages bypass Traintastic’s normal handling. You need a solid understanding of DCC to avoid conflicts. Side effects may occur that Traintastic is not aware of or cannot manage.

Limited support

Not supported by all LocoNet command stations.

Parameters:

  • dcc_packet
    Table containing up to five DCC packet bytes to send excluding checksum byte.

  • repeat
    Number of times to repeat the packet on the track. (1...7)

Return values
true if send to the command station, false otherwise.

send(packet)

Send LocoNet packet.

Use this with caution!

These messages bypass Traintastic’s normal handling. You need a solid understanding of LocoNet to avoid conflicts. Side effects may occur that Traintastic is not aware of or cannot manage.

Parameters:

  • packet
    LocoNet packet bytes, excluding checksum.

Return values
true if send, false otherwise.