FREMO Interlocking: Elekdra MR - General Items - Specification

FREMO Interlocking

Elekdra MR -> General Items

07.09.2005

Specification - Interface to GUI

This Page describes the interface between Elekdra an a GUI.

To give the user the possibility to use the interface he preferes, an open interface is defined. If a user interface supports this interface, it is possible to work with Elekdra.

General

The interface is build up as a TCP/IP Port and supports multiple clients. Currently, the port is 2143.

The protocoll is XML.

Protocoll

The interface communicates with XML.

The top level of the communication identifies the client (e.g. telnet). This tag has to be open until the connection is closed.

All following tags are for communication.

Received by Elekdra
TAG SUBTAG DESCRIPTION

command - A command is following
- exit Force Elekdra to shutdown

switch - used to swith status of elements

set - unsed to set status of elements

get - used to get the status of elements

Sent by Elekdra
TAG SUBTAG DESCRIPTION

status - Indicates the status of an element
msg - Sends a message

Commands

<command>exit</command>
Forces Elekdra to shutdown.

<switch><turnout><direction>W1</direction></turnout></switch>
Switches Turnout "W1"