Documentation

Knowledge Base

Answers, guides and best practices for ComfortClick bOS.

Open in Confluence

Variable Types

BOS offers the capability to create and manage a variety of variable types, including boolean, integer, double, mode, and string. These versatile variables can be seamlessly integrated into various aspects of the configuration, providing extensive flexibility and functionality. 

Table of contents

Variables and Usages

Below is a detailed overview of each variable type and their potential applications:

Boolean Variable:

  • Boolean variables store true/false values.

  • Ideal for toggling settings, managing state conditions, and creating conditional logic in your configuration.

  • A boolean variable can be used to turn device on/off, see current status of an alarm, etc.

Integer Variable:

  • Integer variables hold whole numbers.

  • Suitable for counting items, indexing arrays, and any scenario requiring numerical values without decimals.

  • An integer variable can be used to control fan speeds, shade position and any other full number value.

Double Variable:

  • Double variables store floating-point numbers, allowing for decimal precision.

  • Perfect for scenarios requiring precise measurements, calculations, and handling real numbers.

  • A double variable can store the precise temperature value from a sensor, consumption values, etc.

Mode Variable:

  • Mode variables are used to define different states or modes of operation within the system.

  • Useful for setting operational states, defining user modes, and managing configuration states.

  • A mode variable could be set to values like fan mode, heating modes, events and regimes.

String Variable:

  • String variables store text data.

  • Essential for handling text, such as names, descriptions, paths, and any alphanumeric data.

  • A string variable can store the name or identifier of a device, parsed text data can be stored under string as well.

Mode

The Mode task is used to create a list of predefined modes that can be selected and used in the bOS configuration.

Modes are useful when a project needs to switch between different operating states. They can be used for many purposes, such as seasons, heating modes, cooling modes, occupancy status, presence states, building modes, or custom user-defined modes.

Common examples include:

  • Season mode — Summer, Winter, Transitional

  • Heating mode — Comfort, Eco, Night, Away

  • Occupancy mode — Occupied, Unoccupied

  • Presence mode — Home, Away, Vacation

  • Building mode — Normal, Party, Cleaning, Security

To create or edit available modes, select the Mode task, open the Values tab, and edit the Unit value collection.

In the Collection settings, add the different modes that should be available in the project. These modes can then be selected and used in tasks, visualization, schedules, scenes, alerts, and automation logic.

This makes the Mode task useful for creating clear operating states that can control how the building behaves in different situations.

mode.jpg

After the available modes are created, selecting a mode can trigger different actions in the bOS configuration.

Modes can be used to activate scenes, enable or disable schedules, change setpoints, control devices, or adjust the behavior of other tasks.

For example, selecting Away mode can turn off selected lights, lower heating, close blinds, and enable security-related functions. Selecting Comfort mode can restore normal room temperature, activate selected schedules, and prepare the building for regular use.

Modes are useful because they allow multiple settings and actions to be controlled from one clear selection. Instead of changing each device or task manually, the user can simply select the required mode and let bOS apply the configured behavior automatically.

a8672d2c-ef1a-44ee-82a9-f8241271f2c7.jpg

Top