Configuration file format

Introduction

Torc is configured via an XML file. By design, the structure and format of this file is highly specific

• this is to ensure that it operates exactly as the user intended. Subtle (and not so subtle) errors should not lead to unexpected behaviour.

General XML notes

1. All XML definitions are case sensitive.

Device specification

All devices require a "<name>" tag that uniquely identifies that device. To that end, a name must be unique, must not be empty and for internal purposes can only contain alphanumeric characters (a-z, A-Z and 0-9) as well as '_' and '-',

Devices may also have "<username>" and "<userdescription>" tags. These do not affect the operation of the device and are used purely for a user friendly interface.

Input devices

As well as the default device specifications, an input device must specify a default value and any type specific values (e.g. gpiopinnumber for a GPIO input).

Control devices

Control devices provide the 'intelligence' to Torc's behaviour. They generally take one or more input values (from input devices or other control devices) and generate a different output value. Control devices can output to one or more other control devices , some notification devices and output devices.

1. Timer devices

Timer devices must have no inputs.

1. Transition devices

Transition devices must have exactly one input and must also specifiy a duration for the transition.

1. Logic devices

Configuration errors not (currently) identified by XSD validation.

1. Circular device references.
2. Self reference (i.e. a direct circular reference).
3. Multiple inputs to an output.
4. Reciprocal outputs/inputs (i.e. matched)