Summary

The Cedar config file contains configuration information relating to the behaviour and the bounds of behaviour of Cedar tasks. MATB-II config files are fully compatible with Cedar, but Cedar config files can contain some extra information that is not compatible with MATB-II, see MATB-II Configuration section for details. For information regarding the loading of configuration files, and templates containing default config setups, see the section Config File Formats. For a comprehensive guide of every configuration option in Cedar, see the Standard Config section. The section Cedar Parse Data contains information that may assist interpreting the table layout of Standard Config section.

MATB-II Compatibility

All MATB-II cedar files are compatible with Cedar, however some Cedar config types are not backwards compatible:

• The RESMAN_TLEVELS type is unique to Cedar and overrides some MATB-II Resource Management task defaults.
• Within the MODE type, Cedar has defined some new modes that are not backwards compatible:
  • RANDOM_MODE: this allows Cedar to run without any events files, and just triggers random events for a 2 minute period.
  • SILENT_MODE: this mutes any sounds and shows more visual feedback in the Communications task to enable the use of the task without any sound.

Loading of Config Files

Cedar loads one config file on installation by default. This file can be swapped at any point – but must be named and placed according to the guidelines below.

The naming guidlines are strict for each type of input available: JSON or XML. The type of input can be selected after launch and initial load, however. Event files can also be reloaded after launch.

Android

• The config file should be named CEDAR_CONFIG.xml or config.json and placed in a folder named cedar in the root of the Android USB storage.

iOS

• The config file should be named CEDAR_CONFIG.xml or config.json and placed in the app shared storage for the Cedar app.
• See: https://support.apple.com/en-au/HT201301

Loading Alternate Config Files

Alternate config files can be loaded where an alternate events file is present – the same naming rules apply, for example “ALT_CONFIG.xml” would load with “ALT_EVENTS.xml“, see IO Events File Guide for more information on loading alternate files.

Config File Formats

XML

The XML format of Cedar is identical to that of MATB-II. Config items should be modified from this template.

The template contains all settings in default values, note that if any config items are removed from the config file, these defaults will be loaded anyway, in this way, the original MATB config files will load in Cedar.

• The exception to this is the RESMAN_TLEVELS section, which will default to MATB-II parameters if not specified.

XML Event File Template

<?xml version="1.0" encoding="utf-8"?>
<!-- Modified on 06-02-2010 -->
<CEDAR-CONFIG>
<!-- Mode booleans... -->
 <name type="MODE">
 <TRAIN_MODE>false</TRAIN_MODE>
 <RANDOM_MODE>true</RANDOM_MODE>
 <SILENT_MODE>false</SILENT_MODE>
 <FOLDER_PER_RUN_MODE>false</FOLDER_PER_RUN_MODE>
 <EXT>false</EXT>
 </name>
<!-- Resource Management Pump Rates in Units per Minute... -->
<!-- Default PUMP_1 = 800 -->
<!-- Default PUMP_2 = 600 -->
<!-- Default PUMP_3 = 800 -->
<!-- Default PUMP_4 = 600 -->
<!-- Default PUMP_5 = 600 -->
<!-- Default PUMP_6 = 600 -->
<!-- Default PUMP_7 = 400 -->
<!-- Default PUMP_8 = 400 -->
<!-- Default TANK_A = 800 -->
<!-- Default TANK_B = 800 -->
<name type="RESMAN_RATES">
<PUMP_1>800</PUMP_1>
<PUMP_2>600</PUMP_2>
<PUMP_3>800</PUMP_3>
<PUMP_4>600</PUMP_4>
<PUMP_5>600</PUMP_5>
<PUMP_6>600</PUMP_6>
<PUMP_7>400</PUMP_7>
<PUMP_8>400</PUMP_8>
<TANK_A>800</TANK_A>
<TANK_B>800</TANK_B>
</name>

<!-- Resource Management Tank Levels and Parameters -->
<name type="RESMAN_TLEVELS">
<CAPACITY>4000</CAPACITY>
<INITIAL>2000</INITIAL>
<MIN>1400</MIN>
<MAX>2600</MAX>
</name>
<!-- Time Out in seconds... -->
 <name type="TIMEOUT">
 <RATE>30</RATE>
 <TASK_COMM>5</TASK_COMM>
 <TASK_SYSMON_SCALES>5</TASK_SYSMON_SCALES>
 <TASK_SYSMON_LIGHTS>5</TASK_SYSMON_LIGHTS>
 </name>
<!-- Recording Interval in seconds... -->
<name type="RECORDING_INTERVAL">
<TASK_RESMAN>30</TASK_RESMAN>
</name>
</CEDAR-CONFIG>

JSON

The template contains all settings in default values, note that if any config items are removed from the config file, these defaults will be loaded anyway, in this way, the original MATB config files will load in Cedar. The _type attribute as the final attribute in an event object is critical, this is used to anchor the end of an config object for parsing. The following online converter can be used to correctly convert MATB-II XML files to Cedar JSON files:

http://convertjson.com/xml-to-json.htm

• The exception to this is the RESMAN_TLEVELS section, which will default to MATB-II parameters if not specified.

{
 "MATB-CONFIG": {
 "name": [
 {
 "TRAIN_MODE": "true",
 "RANDOM_MODE": "true",
 "SILENT_MODE": "false",
 "EXT" : "false",
 "_type": "MODE"
 },
 {
 "PUMP_1": "800",
 "PUMP_2": "600",
 "PUMP_3": "800",
 "PUMP_4": "600",
 "PUMP_5": "600",
 "PUMP_6": "600",
 "PUMP_7": "400",
 "PUMP_8": "400",
 "TANK_A": "800",
 "TANK_B": "800",
 "_type": "RESMAN_RATES"
 },
 {
 "CAPACITY": "4000",
 "INITIAL": "2000",
 "MIN": "1400",
 "MAX": "2600",
 "_type": "RESMAN_TLEVELS"
 },
 {
 "RATE": "10",
 "TASK_COMM": "30",
 "TASK_SYSMON_SCALES": "5",
 "TASK_SYSMON_LIGHTS": "5",
 "TASK_EXT": "5",
 "_type": "TIMEOUT"
 },
 {
 "TASK_RESMAN": "05",
 "_type": "RECORDING_INTERVAL"
 }
 ]
 }
}

Cedar Parse Data

The Cedar parser, regardless of parsed format, forms a parse tree to store data in a specific way – below is an example a flat representation of the first 5 config values as they are stored in the parse tree.

Standard Config

• config values are literal, except in the case of the use of parentheses or forward slashes, for example:
  • p(1,2) means values p1 and p2
  • one/two values one and two
• integer values refer to 32-bit ints