Appendix B — Function reference

Every effect available in iDM3 3.5.3, and the 61 that come predefined.

A function is what a wire does to its consumer. You do not choose these directly on a wire — you define a named user function in the Function manager that wraps one of them, then pick that name on the wire. See Chapter 19 §19.3.

Two parts to this appendix:

Part 1 — the 61 functions a project gets from New from default. Start here; most of what you need already exists.
Part 2 — every function the software defines, for when you need to build your own.

Function parameters

Parameter

On screen

Range

Delay

Digital delay (s) / Analog_Delay

0 s – 24 h

Impulse time

Digital impulse time (s)

0 s – 24 h

Level

Analog value (%) / Analog level

0 % – 100 %

Ramp length

Analog ramp delay (s)

0 s – 1 h

Increment step

Analog inc dec step

0 % – 100 %

Increment time

Analog inc dec time

0 s – 1 h

Auto-off time

Analog switch OFF over (s)

0 s – 24 h

Counter value

Counter value

0 – 4 294 967 295

Temperature

Set temperature, Set heat temperature, Set cool temperature

−40 °C – +200 °C, 0.1 °C steps

Until

Until DateTime, For time

—

Ramp length is the time for a full 0 % → 100 % sweep, not the time for the change you asked for. A 10-second ramp moves 10 % → 30 % in 2 seconds. See Tutorial 3 §Step 5.

Part 1 — the predefined functions

A project created with New from default contains these 61 already. Names are the software's, not this manual's.

Name

Function

Parameters

DIGITAL_ON

Digital_SwitchOn

—

DIGITAL_OFF

Digital_SwitchOff

—

DIGITAL_SWITCH

Digital_SwitchValue

—

DIGITAL_IMPULSE_1S

Digital_Impulse_ON

Digital_Delay_Second=00:00:00; Digital_ImpulseTime_Second=00:00:01

DIGITAL_IMPULSE_5S

Digital_Impulse_ON

Digital_Delay_Second=00:00:00; Digital_ImpulseTime_Second=00:00:05

DIGITAL_IMPULSE_1MIN

Digital_Impulse_ON

Digital_Delay_Second=00:00:00; Digital_ImpulseTime_Second=00:01:00

DIGITAL_IMPULSE_5MIN

Digital_Impulse_ON

Digital_Delay_Second=00:00:00; Digital_ImpulseTime_Second=00:05:00

DIGITAL_COPY

Digital_Copy

—

ANALOG_ON

Analog_SwitchOn

—

ANALOG_OFF

Analog_SwitchOff

—

ANALOG_SWITCH

Analog_SwitchValue

—

ANALOG_BRIGHTEN

Analog_SwitchOnWRamp

Analog_Delay=00:00:00; Analog_RampDelay_Second=00:00:04

ANALOG_DIM

Analog_SwitchOffWRamp

Analog_Delay=00:00:00; Analog_RampDelay_Second=00:00:04

ANALOG_STOP_LEVEL_CHANGE

Analog_StopChangingLevel

—

ANALOG_COPY

Analog_Copy

—

ANALOG_SET_LEVEL_0

Analog_SetLevel

Analog_Level=0

ANALOG_SET_LEVEL_25

Analog_SetLevel

Analog_Level=25

ANALOG_SET_LEVEL_50

Analog_SetLevel

Analog_Level=50

ANALOG_SET_LEVEL_75

Analog_SetLevel

Analog_Level=75

ANALOG_SET_LEVEL_100

Analog_SetLevel

Analog_Level=100

COUNTER_VALUE_INCREMENT

Counter_Increment

—

COUNTER_VALUE_DECREMENT

Counter_Decrement

—

COUNTER_VALUE_RESET

Counter_Reset

—

TIMER_START

Timer_Start

—

TIMER_STOP

Timer_Stop

—

TIMER_RESET

Timer_Reset

—

SHUTTER_PULL_UP/DOWN

Digital_Impulse_ON

Digital_Delay_Second=00:00:00; Digital_ImpulseTime_Second=00:01:00

SHUTTER_TILT_UP/DOWN

Digital_Impulse_ON

Digital_Delay_Second=00:00:00; Digital_ImpulseTime_Second=00:00:00.8000000

SYSTEM_INTEGER_INCREMENT

SysInt_Increment

Analog_IncDecStep=1

SYSTEM_INTEGER_DECREMENT

SysInt_Decrement

Analog_IncDecStep=1

SYSTEM_INTEGER_COPY_VALUE

SysInt_Copy

—

SYSTEM_INTEGER_RESET

SysInt_Reset

—

DIGITAL_GROUP_ON

GroupDigital_SwitchOn

—

DIGITAL_GROUP_OFF

GroupDigital_SwitchOff

—

DIGITAL_GROUP_SWITCH

GroupDigital_SwitchValue

—

ANALOG_GROUP_ON

GroupAnalog_SwitchOn

—

ANALOG_GROUP_OFF

GroupAnalog_SwitchOff

—

ANALOG_GROUP_SWITCH

GroupAnalog_SwitchValue

—

ANALOG_GROUP_BRIGHTEN

GroupAnalog_SwitchOnWRamp

Analog_Delay=00:00:00; Analog_RampDelay_Second=00:00:04

ANALOG_GROUP_DIM

GroupAnalog_SwitchOffWRamp

Analog_Delay=00:00:00; Analog_RampDelay_Second=00:00:04

ANALOG_GROUP_STOP_LEVEL_CHANGE

GroupAnalog_StopChangingLevel

—

HEATING_COOLING_START

HeatCool_StartTimeProgram

—

HEATING_COOLING_STOP

HeatCool_StopTimeProgram

—

HEATING_COOLING_NORMAL_PLAN

HeatCool_SetTimeProgram

—

HEATING_COOLING_HOLIDAY_PLAN

HeatCool_SetHolidayTimeProgram

—

HEATING_COOLING_PUBLIC_HOLIDAY_PLAN

HeatCool_SetPublicHolidayTimeProgram

—

HEATING_COOLING_SWITCH_TO_HEATING

HeatCool_SetHeatWithManual

—

HEATING_COOLING_SWITCH_TO_COOLING

HeatCool_SetCoolWithManual

—

HEATING_COOLING_SWITCH_TO_FAVORITE1

HeatCool_SetProgramMinimum

—

HEATING_COOLING_SWITCH_TO_FAVORITE2

HeatCool_SetProgramAttenuate

—

HEATING_COOLING_SWITCH_TO_FAVORITE3

HeatCool_SetProgramNormal

—

HEATING_COOLING_SWITCH_TO_FAVORITE4

HeatCool_SetProgramComfort

—

HEATING_COOLING_CANCEL_MANUAL

HeatCool_CancelManual

—

AnalogOnRamp5s

Analog_SwitchOnWRamp

Analog_Delay=00:00:00; Analog_RampDelay_Second=00:00:05

AnalogOffRamp5s

Analog_SwitchOffWRamp

Analog_Delay=00:00:00; Analog_RampDelay_Second=00:00:05

SysIntUp1

SysInt_Increment

Analog_IncDecStep=1

SysIntDown1

SysInt_Decrement

Analog_IncDecStep=1

DigitalImpuls1s

Digital_Impulse_ON

Digital_Delay_Second=00:00:00; Digital_ImpulseTime_Second=00:00:01

DigitalImpuls5s

Digital_Impulse_ON

Digital_Delay_Second=00:00:00; Digital_ImpulseTime_Second=00:00:05

DigitalImpuls0s5

Digital_Impulse_ON

Digital_Delay_Second=00:00:00; Digital_ImpulseTime_Second=00:00:00.5000000

DigitalImpuls0s5Delay2s

Digital_Impulse_ON

Digital_Delay_Second=00:00:02; Digital_ImpulseTime_Second=00:00:00.5000000

SHUTTER_PULL_UP/DOWN and SHUTTER_TILT_UP/DOWN carry one name for both directions. The direction comes from which output the wire drives, not from the function. See Tutorial 5.

HEATING_COOLING_SWITCH_TO_FAVORITE1–4 map onto the older names minimum, attenuate, normal and comfort. Same four settings, older vocabulary.

Part 2 — all 108 functions

Everything the software defines. Use these when building your own definitions in the Function manager.

The function's type must match the consumer — a Digital function will not be offered for a dimmer, and an Analog one will not be offered for a relay.

Many labels are untranslated in 3.5.3. Where the English translation is missing, iDM3 falls back to the function's internal name — so the dropdown shows GroupDigital_SwitchOn rather than "Group digital switch ON". Every GroupDigital_* and GroupAnalog_* function is affected, along with Digital_Impulse_ON, Digital_Impulse_OFF, Analog_DelaySwitchOn and Analog_DelaySwitchValue. This manual prints what you will actually see. Older documentation prints the tidy English names, which is why the two do not match.

Digital

On screen

Internal name

Code

Digital switch ON

Digital_SwitchOn

0x0100

Digital switch OFF

Digital_SwitchOff

0x0101

Digital switch value

Digital_SwitchValue

0x0102

Digital delay switch ON

Digital_DelaySwitchOn

0x0103

Digital delay switch OFF

Digital_DelaySwitchOff

0x0104

Digital delay switch value

Digital_DelaySwitchValue

0x0105

Digital_Impulse_ON

0x0120

Digital_Impulse_OFF

0x0121

Digital impulse

Digital_Impulse

0x0122

Digital copy

Digital_Copy

0x0123

Analog

On screen

Internal name

Code

Analog switch ON

Analog_SwitchOn

0x0800

Analog switch OFF

Analog_SwitchOff

0x0801

Analog switch value

Analog_SwitchValue

0x0802

Analog_DelaySwitchOn

0x0803

Analog delay switch OFF

Analog_DelaySwitchOff

0x0804

Analog_DelaySwitchValue

0x0805

Analog switch ON w auto OFF

Analog_SwitchOnWAutoOff

0x0806

Analog switch ON w ramp

Analog_SwitchOnWRamp

0x0807

Analog switch OFF w ramp

Analog_SwitchOffWRamp

0x0808

Analog increasing level

Analog_IncreasingLevel

0x0809

Analog decreasing level

Analog_DecreasingLevel

0x080A

Analog stop changing level

Analog_StopChangingLevel

0x080B

Analog set level

Analog_SetLevel

0x080C

Analog set level w ramp

Analog_SetLevelWRamp

0x080D

Analog copy

Analog_Copy

0x0823

Group digital

On screen

Internal name

Code

GroupDigital_SwitchOn

0x8100

GroupDigital_SwitchOff

0x8101

GroupDigital_SwitchValue

0x8102

GroupDigital_DelaySwitchOn

0x8103

GroupDigital_DelaySwitchOff

0x8104

GroupDigital_DelaySwitchValue

0x8105

GroupDigital_Impulse_ON

0x8120

GroupDigital_Impulse_OFF

0x8121

GroupDigital_Impulse

0x8122

GroupDigital_Copy

0x8123

Group analog

On screen

Internal name

Code

GroupAnalog_SwitchOn

0x8800

GroupAnalog_SwitchOff

0x8801

GroupAnalog_SwitchValue

0x8802

GroupAnalog_DelaySwitchOn

0x8803

GroupAnalog_DelaySwitchOff

0x8804

GroupAnalog_DelaySwitchValue

0x8805

GroupAnalog_SwitchOnWAutoOff

0x8806

GroupAnalog_SwitchOnWRamp

0x8807

GroupAnalog_SwitchOffWRamp

0x8808

GroupAnalog_StopChangingLevel

0x880B

GroupAnalog_SetLevel

0x880C

GroupAnalog_SetLevelWRamp

0x880D

GroupAnalog_Copy

0x8823

Timers

On screen

Internal name

Code

Timer start

Timer_Start

0x0340

Timer stop

Timer_Stop

0x0341

Timer reset

Timer_Reset

0x0342

Counters

On screen

Internal name

Code

Counter increment

Counter_Increment

0x0450

Counter decrement

Counter_Decrement

0x0451

Counter reset

Counter_Reset

0x0452

Counter set value

Counter_SetValue

0x0453

System integers

On screen

Internal name

Code

Sys int increment

SysInt_Increment

0x0210

Sys int decrement

SysInt_Decrement

0x0211

Sys int copy

SysInt_Copy

0x0212

Sys int set

SysInt_Set

0x0213

Sys int reset

SysInt_Reset

0x0214

Heating and cooling

On screen

Internal name

Code

HeatCool_SetProgramComfortToTimeStamp

0x0770

HeatCool_TempSet

0x0771

HeatCool_SetProgramNormalToTimeStamp

0x0772

Heat cool set time program

HeatCool_SetTimeProgram

0x0773

Heat cool start time program

HeatCool_StartTimeProgram

0x0774

Heat cool stop time program

HeatCool_StopTimeProgram

0x0775

HeatCool_SetProgramAttenuateToTimeStamp

0x0776

Heat cool set program comfort

HeatCool_SetProgramComfort

0x0777

Heat cool set program normal

HeatCool_SetProgramNormal

0x0778

Heat cool set program attenuate

HeatCool_SetProgramAttenuate

0x0779

Heat cool set program minimum

HeatCool_SetProgramMinimum

0x077A

HeatCool_SetProgramMinimumToTimeStamp

0x077B

HeatCool_TempSetCool

0x077C

HeatCool_SetManualToTime

0x077D

HeatCool_SetUserTemperature1UntilTime

0x077E

HeatCool_SetUserTemperature2UntilTime

0x077F

HeatCool_SetUserTemperature3UntilTime

0x0780

HeatCool_SetUserTemperature4UntilTime

0x0781

HeatCool_SetAntifreezeTemperatureUntilTime

0x0782

HeatCool_SetMaximalTemperatureUntilTime

0x0783

HeatCool_SetManualUntilTime

0x0784

HeatCool_SetCoolWithManual

0x0785

HeatCool_SetHeatWithManual

0x0786

HeatCool_SetCoolCancelManual

0x0787

HeatCool_SetHeatCancelManual

0x0788

HeatCool_CancelManual

0x0789

HeatCool_SetHolidayTimeProgram

0x078A

HeatCool_SetPublicHolidayTimeProgram

0x078B

HeatCool_SetManual

0x078C

HeatCool_SetHCManual

0x078D

HeatCool_SetHCManualToTime

0x078E

HeatCool_SetHCManualUntilTime

0x078F

HeatCool_Copy

0x0790

HeatCool_Low

0x0791

HeatCool_Med

0x0792

HeatCool_Hi

0x0793

HeatCool_Auto

0x0794

HeatCool_Off

0x0795

HeatCool_SetFan

0x0796

HeatCool_SetEco

0x0797

HeatCool_SetFanToTimeStamp

0x0798

HeatCool_SetEcoToTimeStamp

0x0799

Alarms

On screen

Internal name

Code

Alarm activate

Alarm_Activate

0x0560

Alarm deactivate

Alarm_Deactivate

0x0561

Alarm refresh

Alarm_Refresh

0x0562

Alarm test

Alarm_Test

0x0563

Alarm alert

Alarm_Alert

0x0564

Other

On screen

Internal name

Code

Not specified

NotSpecified

0x0000

Notes on particular groups

Digital impulse variants behave differently and the difference matters:

Function

Behaviour

Digital_Impulse_ON

Does nothing if the output is already on. Otherwise: delay, on, impulse time, off.

Digital_Impulse_OFF

The mirror image. Does nothing if already off.

Digital impulse

Ignores the current state. Delay, flip, impulse time, flip back.

Copy functions translate between digital and analog: 0 % = OFF and 1–100 % = ON going one way, OFF = 0 % and ON = 100 % going the other.

Group functions are identical to their singular counterparts but act on every member of a group. See Tutorial 4.

Heating and cooling has by far the largest set — including functions that hold a temperature until a given time, and that override the antifreeze and maximum limits. Most installations need only the twelve predefined ones in Part 1.

Some functions have no on-screen label and are marked (no label). They exist in the software but are not offered for selection.

PreviousAppendix A — Action reference

NextAppendix C — Menu and button reference