Wintermute User Guide - commands:zone_commands

history

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

history: Prints the history of logged statuses for the named zone or variable to the System Log; this should generally only be used for programming/debugging * name is the name of the zone or variable to print out logged statuses for

increment

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

increment: | Assuming the given zone variable is an integer, increments it by the given value * name is the name of the zone or variable to be incremented * value is the value to increment the variable by; it can be negative but must be an integer

new_showzone

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

new_showzone: | | Adds a new zone as part of the show flow * zone is the name of the zone * index is the position in the show flow * depth is the number of groups contained in this zone

new_variable

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

new_variable: . | filter Creates a new variable within a previously created zone * zone is the name of the zone containing the variable * variable is the name of the new variable * filter is an optional flag – if present, the variable will only take values that can be parsed as floats, and these will be low-pass filtered to remove noise

new_zone

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

new_zone: | Adds a new zone that is not part of the show flow * zone is the name of the zone * category is its category; this only affects how the zone is displayed in Wintermute’s tree structure and has no other meaning

select

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

select: | :: :: :: The select command allows for more sophisticated branching than the bracket prefix to a single command. An arbitrary number of conditions can be used - at least same number of commands must be supplied - or an extra command can be supplied as a default which will be run if none of the conditions are met. Note that if multiple conditions are met, on the first condition/command pair will be executed.

select_max

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

select_max: | :: :: :: select_min: | :: :: :: These commands allow for more sophisticated branching than the bracket prefix to a single command. A command will be executed based on the largest/smallest value present.

set

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

set: | | log Sets the status of a previously created zone or variable * name is the name of the zone or variable to be set * status is the value to set it to * log is a flag that means that this status will be added to the history stack for this zone or variable (optional)

start

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

Setting up zones: * new_zone * new_showzone * zone_flowcondition * zone_resetconditions Setting up variables: * new_variable * trigger_add * trigger_arm * trigger_clear Manipulating zones and variables: * set * increment * history * zone_timerstart * zone_timerpause * zone_timerresume * zone_timerstop Branching based on variables: * select * select_max * select_min

trigger_add

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

trigger_add: . | | string/rise/fall/both | oneshot/reset/ :: This sets a trigger on a variable * zone is the zone containing the variable * variable is the variable to have the trigger added to * level is the value at which the trigger will fire

trigger_arm

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

trigger_arm: . | This arms triggers on a variable * zone is the zone containing the variable * variable is the variable to have the triggers armed on * If level is present, only triggers with that level will be armed Note that as the variable field takes wildcards, you could for example arm an entire zone with:

trigger_clear

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

trigger_clear: . This clears all triggers set on a variable * zone is the zone containing the variable * variable is the variable to be cleared

zone_flowcondition

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

zone_flowconditon: | | | etc… Adds to the conditions (expressed in the same manner as command conditionals, albeit without brackets) for a zone to advance, per flow_trysingle and flow_tryadvance. * zone is the zone to be affected * condition 1/2/etc…

zone_resetconditions

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

zone_resetconditions: Clears the conditions for a zone to advance. * zone is the zone to be affected

zone_timerstart

Anonymous (anonymous@undisclosed.example.com) — 2025-05-17T20:51:57+00:00

zone_timerstart: | | | | zone_timerpause: {name} zone_timerresume: {name} zone_timerstop: {name} Each show zone has and associated time that can be controlled via the commands above * zone is the zone of the timer to be controlled