Skip to content

Coordinator Legacy Config

Mikayla edited this page May 4, 2024 · 2 revisions

Warning

ARCHIVED PAGE: The coordinator no longer uses a config.lua file. Please see the page on the Coordinator Configurator.

For details on common fields, see this page. Coordinator specific fields are identified below.

NUM_UNITS here is used to validate the number of displays before a supervisor connection has been established, which provides the final ruling on how many units there actually are. SOUNDER_VOLUME is used for speaker.play() for the alarm sounder, this defaults to 1.0. If you want things to be extra loud or quite, feel free to change it here. TIME_24_HOUR allows you to selected 24-hour or 12-hour time for the coordinator's main clock display. Do note, there is a bug with 12-hour time formatting on older versions of CC: Tweaked.

There is an optional field to disable the flow view monitor for legacy setups that do not have space for a new monitor. Setting DISABLE_FLOW_VIEW to true will disable this view and the requirement for having that additional monitor.

local config = {}

-- supervisor comms channel
config.SVR_CHANNEL = 16240
-- coordinator comms channel
config.CRD_CHANNEL = 16243
-- pocket comms channel
config.PKT_CHANNEL = 16244
-- max trusted modem message distance (0 to disable check)
config.TRUSTED_RANGE = 0
-- time in seconds (>= 2) before assuming a remote device is no longer active
config.SV_TIMEOUT = 5
config.API_TIMEOUT = 5
-- facility authentication key (do NOT use one of your passwords)
-- this enables verifying that messages are authentic
-- all devices on the same network must use the same key
-- config.AUTH_KEY = "SCADAfacility123"

-- expected number of reactor units, used only to require that number of unit monitors
config.NUM_UNITS = 4

-- alarm sounder volume (0.0 to 3.0, 1.0 being standard max volume, this is the option given to to speaker.play())
-- note: alarm sine waves are at half saturation, so that multiple will be required to reach full scale
config.SOUNDER_VOLUME = 1.0

-- true for 24 hour time on main view screen
config.TIME_24_HOUR = true

-- disable flow view (for legacy layouts)
config.DISABLE_FLOW_VIEW = false

-- log path
config.LOG_PATH = "/log.txt"
-- log mode
--  0 = APPEND (adds to existing file on start)
--  1 = NEW (replaces existing file on start)
config.LOG_MODE = 0
-- true to log verbose debug messages
config.LOG_DEBUG = false

return config
Clone this wiki locally