The 'Flag' function

Description

A FLAG is a status indicator that can have two states: ON (TRUE) or OFF (FALSE). It’s a simple yet effective tool for transmitting statuses between various functions or inputs. Below, we explore its basic functionality and potential applications.

Parameters

Within the function

Function behaviour when used on an interface

Not applicable

Application examples

• Status Transfer: a FLAG can transmit the status of a contact input or link functions. For example, one function can toggle the FLAG to ON or OFF, while another function (like an If-Then-Else function) checks the FLAG’s status and executes an action accordingly.
• Automation: a FLAG can activate a specific mode. e.g. ‘at home’ mode, allowing you to decide whether shutters should automatically open early on weekday mornings.
• Alarm Integration: FLAGs can also manage security features. For instance, an output contact from a burglar alarm system (armed/disarmed) can be connected to a contact input of an interface, like the TDS12117. This status is linked via a transparent function to the FLAG ‘ALARM ARMED’. Using a TELETASK proximity reader, access can be controlled based on this alarm status. Residents, for example, could always have access, while house staff is denied entry when the alarm system is armed.

Below you will find an example of using a FLAG in CARDSOFT (PROSOFT 4). In this case, the group 'household staff' is granted access to all readers when the FLAG 'ALARM ACTIVATED (ARMED)' is set to OFF.

In the screenshot below, the If-Then-Else function checks if the FLAG ‘LG HEAT’ is set to ON. If this is the case, the corresponding command in the ‘THEN’ section is executed.

Behaviour when using a FLAG in another function

A FLAG can be controlled within a function, such as a ‘Local Mood’. The behavior of the FLAG depends on the intended goal, which can be configured in four different ways:

• ON: The FLAG is set to ON (and remains ON if it was already active).
• OFF: The FLAG is set to OFF when the ‘Local Mood’ is activated and stays OFF, regardless whether the ‘Local Mood’ is deactivated or not.
• ON/OFF: The FLAG mirrors the status of the ‘Local Mood’. When the ‘Local Mood’ is activated, the FLAG is set to ON. When the ‘Local Mood’ is deactivated, the FLAG changes to the OFF status. Note: To enable this functionality, the ‘Local Mood’ must be configured as ‘Toggle’ (=reversible).
• OFF/OFF: The FLAG is set to OFF when the ‘Local Mood’ is activated and remains OFF even if the ‘Local Mood’ is deactivated.