openHAB

# Velbus Binding

The Velbus binding integrates with a Velbus (opens new window) system through a Velbus configuration module (VMBRSUSB, VMB1USB or VMB1RS) or a network connection (TCP/IP).

For optimal stability, the preferred configuration module is the VMBRSUSB module. Consider deploying a TCP bridge – the officially developed python-velbustcp (opens new window) or one of the third party projects (opens new window) – in between the configuration module and openHAB. Doing so allows concurrent access to your Velbus system by both openHAB and the official configuration software.

The binding exposes basic actions from the Velbus System that can be triggered from the smartphone/tablet interface, as defined by the Velbus Protocol info sheets (opens new window).

Supported item types are switches, dimmers and rollershutters. Pushbutton, temperature sensors and input module states are retrieved and made available in the binding.

# Supported Things

In addition to the bridge modules mentioned in the section above, the supported Velbus modules are:

Type Description
vmb1bl 1-channel blind control module for din rail
vmb1bls 1-channel blind control module for universal mounting
vmb1dm Dimmer module for inductive/resistive and capacitive load
vmb1led 1-channel 0-10V controlled PWM dimmer for led strips
vmb1ry 1-channel relay module
vmb1ryno 1-channel relay module with potential-free changeover contact
vmb1rynos 1-channel relay module with potential-free changeover contact
vmb1rys 1-channel relay module with input
vmb1ts Temperature Sensor Module
vmb2bl 2-channel blind control module
vmb2ble-10 2-channel blind control module with extended possibilities
vmb2ble 2-channel blind control module with extended possibilities
vmb2dc-20 2-channel 0 to 10 V dimmer control module
vmb2pbn Push-button interface for Niko 1- or 2-fold push-buttons
vmb4an Analog I/O module
vmb4dc 4-channel 0/1-10V dimmer controller
vmb4ledpwm-20 4-channel led PWM dimmer module
vmb4pb 4 button interface module
vmb4ry 4-channel relay module
vmb4ryld-10 4-channel relay module with voltage outputs
vmb4ryld-20 4-channel relay module with voltage outputs
vmb4ryld 4-channel relay module with voltage outputs
vmb4ryno-10 4-channel relay module with potential-free contacts
vmb4ryno-20 4-channel relay module with potential-free contacts
vmb4ryno 4-channel relay module with potential-free contacts
vmb6in 6-channel input module
vmb6pb-20 6-button interface module
vmb6pbn Push-button interface module for Niko 4- or 6-fold push-button
vmb7in 7-channel input module (potential-free + pulse)
vmb8dc-20 8-channel 0 to 10 V dimmer control module
vmb8in-20 8-channel input module (potential-free + pulse)
vmb8ir Infrared remote control receiver module
vmb8pb 8-Channel Push Button module
vmb8pbu Push-button interface with 8 channels for universal mounting
vmbdali-20 DALI gateway module
vmbdali DALI gateway module
vmbdme Dimmer for electronic/resistive load
vmbdmir Single channel triac dimmer for resistive and inductive loads
vmbdmi Single channel triac dimmer for resistive and inductive loads
vmbel1-20 Edge-lit one touch button module
vmbel1 Edge-lit one touch button module
vmbel2-20 Edge-lit two touch buttons module
vmbel2 Edge-lit two touch buttons module
vmbel4pir-20 Edge-lit Motion detector with four touch buttons
vmbel4-20 Edge-lit four touch buttons module
vmbel4 Edge-lit four touch buttons module
vmbelo-20 Edge-lit touch panel with OLED display
vmbelo Edge-lit touch panel with OLED display
vmbelpir Edge-lit Motion detector with one touch button
vmbgp1-20 Glass control module with 1 touch key
vmbgp1-2 Glass control module with 1 touch key (Edition 2)
vmbgp1 Glass control module with 1 touch key
vmbgp2-20 Glass control module with 2 touch keys
vmbgp2-2 Glass control module with 2 touch keys (Edition 2)
vmbgp2 Glass control module with 2 touch keys
vmbgp4-20 Glass control module with 4 touch keys
vmbgp4-2 Glass control module with 4 touch keys (Edition 2)
vmbgp4 Glass control module with 4 touch keys
vmbgp4pir-20 Glass control module with 4 touch keys and built-in motion and twilight sensor
vmbgp4pir-2 Glass control module with 4 touch keys and built-in motion and twilight sensor (Edition 2)
vmbgp4pir Glass control module with 4 touch keys and built-in motion and twilight sensor
vmbgpod-2 Glass control module with OLED display and temperature controller (Edition 2)
vmbgpod Glass control module with OLED display and temperature controller
vmbgpo-20 Glass control module with OLED display and temperature controller
vmbgpo Glass control module with OLED display
vmbgptc Glass control module with OLED display
vmbin 1-channel input module
vmbkp Keypad interface module
vmbmeteo Weather station with thermometer, anemometer, rain sensor and light sensor
vmbpir-20 Mini motion and twilight sensor for recessed or surface mounting
vmbpirc Motion and twilight sensor for ceiling mounting
vmbpirm Mini motion and twilight sensor for recessed or surface mounting
vmbpiro Outdoor motion, twilight and temperature sensor, Theben
vmbpiro-10 Outdoor motion, twilight and temperature sensor, Theben
vmbpiro-20 Outdoor motion, twilight and temperature sensor, Theben
vmbpsumngr-20 PSU Manager
vmbrfr8s 8-channel RF receiver module
vmbsig Signum IoT Gateway Module
vmbsig-20 Signum IoT Gateway Module
vmbsig-21 Signum IoT Gateway Module
vmbvp1 Doorbird interface module

# Discovery

The Velbus bridge cannot be discovered automatically. Configure it manually by defining the serial port of the Velbus Configuration module for the Velbus Serial Bridge or by defining the IP address and port for the Velbus Network Bridge, as described in the Thing Configuration section.

Once the bridge has been configured with openHAB, a manual scan can be initiated to discover Velbus modules with an assigned address. Addresses can be assigned via the official configuration software, and is a required step before a Velbus installation can work correctly.

The discovery scan can take a few minutes to complete. Modules discovered during this scan will appear in the inbox. This procedure will also retrieve the channel names of the Velbus devices.

# Thing Configuration

The Velbus bridge needs to be added first.

# Velbus Serial Bridge

For the Velbus Serial Bridge it is necessary to specify the serial port device used for communication.

On Linux and other UNIX systems, it is recommended to use a more stable symbolic device path such as /dev/serial/by-id/usb-Velleman_Projects_VMB1USB_Velbus_USB_interface-if00, as it will always refer to a Velbus configuration module, and not an arbitrary serial device. If this is not a concern or an option, it is valid to refer to the serial device directly with a path such as /dev/ttyS0, /dev/ttyUSB0 or /dev/ttyACM0 (or a number other than 0 if multiple serial devices are connected.)

On Windows port will refer to one of the COM devices such as COM1, COM2, etc. The Device Manager system utility can be used to determine the exact COM port number to use.

In a .things file, a USB connection to a Velbus configuration module might be configured like so:

Bridge velbus:bridge:1 [ port="/dev/serial/by-id/usb-Velleman_Projects_VMB1USB_Velbus_USB_interface-if00" ]
// or
Bridge velbus:bridge:1 [ port="COM1" ]

# Velbus Network Bridge

For the Velbus Network Bridge it is necessary to specify the address (either an IP address or a hostname) and the port of a Velbus network server.

In a .things file, a network bridge running on the same machine at port 6000 would be configured like so:

Bridge velbus:networkbridge:1 "Velbus Network Bridge - Loopback" @ "Control" [ address="localhost", port=6000 ]

# Real-time Clock Synchronization

Optionally, the openHAB Velbus binding can synchronize the real-time clock, date and daylight saving status of the Velbus modules. This is achieved by setting the Time Update Interval (in minutes) on the bridge Thing. For example:

Bridge velbus:bridge:1 [ port="COM1", timeUpdateInterval="360" ]

If timeUpdateInterval is not specified, the time will be updated every 360 minutes by default. In order to disable this behaviour, set the interval to 0 or an empty string.

# Reconnection

In case of a connection error, a Velbus bridge will attempt to reconnect every 15 seconds by default. You can modify the bridge reconnection interval by specifying the reconnectionInterval parameter (in seconds):

Bridge velbus:bridge:1 [ port="COM1", reconnectionInterval="15" ]

# Velbus modules

Adding Velbus modules to your openHAB configuration follows the conventions of your preferred configuration method.

  • UI-based configuration: Invoke a manual scan from the Things menu in order to start the discovery process. Discovered modules can be found in the inbox.

  • Textual .thing configuration can declare Velbus modules either in a standalone fashion (a bridge is still required):

    Thing velbus:<thingType>:<bridgeId>:<thingId> "Label" @ "Location" [ CH1="Kitchen Light", CH2="Living Light" ]

    Or, more concisely, by nesting modules within the Bridge they’re connected to:

    Bridge velbus:bridge:1 [ port="COM1" ] {
    <thingType> <thingId> "Label" @ "Location" [ CH1="Kitchen Light", CH2="Living Light" ]
}

    Here:

    • <thingType> is the type of the Velbus module. Refer to the Supported Things table for valid <thingType> values;
    • <thingId> is the hexadecimal address of the Velbus module;
    • "Label" is an optional label for the Thing;
    • @ "Location" is an optional specification of the location of the Thing;
    • The CHx="..." properties are optional and can be used to specify names of the module channels.

Individual module Thing’s channels can be linked to openHAB items via channel names like velbus:vmb4ryld:1:0A:CH1. Here, from left to right, the channel name consists of the binding name, module type (<thingType> = vmb4ryld), bridge id (1), module’s hexadecimal address (<thingId> = 0A), and channel within the module (CH1).

# Additional properties

Some module types have additional functionality not represented well by the trigger channels. A prime example of this is a temperature sensor, measurements of which must be polled.

The following table lists these additional properties and the modules that support the corresponding property:

Property Supported modules Description
counter1PulseMultiplier vmb7in The pulse multiplier for counter 1
counter1Unit vmb7in, vmb8in-20 The unit for Counter 1.
counter2PulseMultiplier vmb7in The pulse multiplier for counter 2
counter2Unit vmb7in, vmb8in-20 The unit for Counter 2.
counter3PulseMultiplier vmb7in The pulse multiplier for counter 3
counter3Unit vmb7in, vmb8in-20 The unit for Counter 3.
counter4PulseMultiplier vmb7in The pulse multiplier for counter 4
counter4Unit vmb7in, vmb8in-20 The unit for Counter 4.
counter5Unit vmb8in-20 The unit for Counter 5.
counter6Unit vmb8in-20 The unit for Counter 6.
counter7Unit vmb8in-20 The unit for Counter 7.
counter8Unit vmb8in-20 The unit for Counter 8.
dimspeed vmb1dm, vmb1led, vmb4dc, vmbdme, vmbdmi, vmbdmir The time (in seconds) needed for dimming from 0 to 100%.
refresh vmb1ts, vmb4an, vmb7in, vmbel1, vmbel2, vmbel4, vmbelpir, vmbgp1, vmbgp1-2, vmbgp2, vmbgp2-2, vmbgp4, vmbgp4-2, vmbgp4pir, vmbgp4pir-2, vmbmeteo, vmbpiro, vmbpiro-10, vmbpiro-20, vmb8in-20 Refresh interval for sensors or counters (in seconds), default 300. If set to 0 or left empty, no refresh will be scheduled.
mode vmb4ledpwm-20 The mode used by the dimmer module (4DIM, RGB, RGBW)

The vmbdali and vmbdali-20 Things have 16 virtual light channels. A virtual light combines 3 or 4 VMBDALI module channels into an openHAB channel to control RGB or RGBW lights. This is because an RGBW DALI light is configured on the VMBDALI module with 4 channels (Red channel, Green channel, Blue channel, White channel). The channels of the virtual light can be identified by a module channel CH1 ... CH64 or a DALI address A0 ... A63.

The configuration is set like this:

Thing velbus:vmbdali:<bridgeId>:<thingId> [VL1="R,G,B,W"]

The white channel is optional.

e.g.:

Thing velbus:vmbdali:1:01 [VL1="CH1,CH2,CH3,CH4", VL2="A4,A5,A6"]

# Channels

# Bridges bridge, networkbridge

Supported channels groups Supported channels Supported command types Remarks
bridgeClockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
bridgeClockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number

# Modules vmb1bl, vmb1bls

Supported channels groups Supported channels Supported command types Remarks
CH1 UpDown, StopMove, Percent

# Modules vmb1dm, vmb1led, vmbdme, vmbdmi, vmbdmir

Supported channels groups Supported channels Supported command types Remarks
CH1 OnOff, Percent Sending an ON command will switch the dimmer to the value stored when last turning the dimmer off.

# Module vmb1ry

Supported channels groups Supported channels Supported command types Remarks
CH1 OnOff

# Module vmb4ry

Supported channels groups Supported channels Supported command types Remarks
CH1 ... CH4 OnOff

# Modules vmb1ryno, vmb1rynos, vmb4ryld, vmb4ryld-10, vmb4ryno, vmb4ryno-10

Supported channels groups Supported channels Supported command types Remarks
CH1 ... CH5 OnOff

# Modules vmb4ryld-20, vmb4ryno-20

Supported channels groups Supported channels Supported command types Remarks
CH1 ... CH8 OnOff

# Module vmb1rys

Supported channels groups Supported channels Supported command types Remarks
CH1 ... CH5 OnOff
CH6 Pressed, Long_Pressed
CH6t Pressed, Released, Long_Pressed Trigger

# Module vmb1ts

Supported channels groups Supported channels Supported command types Remarks
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger

# Modules vmb2bl, vmb2ble, vmb2ble-10

Supported channels groups Supported channels Supported command types Remarks
CH1,CH2 UpDown, StopMove, Percent

# Module vmb6in

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH6 Pressed, Long_Pressed
input CH1 ... CH6 Pressed, Released, Long_Pressed Trigger

# Module vmb8ir

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger

# Module vmb7in

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
counter CH1 ... CH4 Number

# Module vmb8in-20

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
counter CH1 ... CH8 Number

# Modules vmb2pbn, vmb6pbn, vmb8pb, vmb8pbu, vmbrfr8s, vmbvp1, vmb6pb-20

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
feedback CH1 ... CH8 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number

# Module vmb4dc

Supported channels groups Supported channels Supported command types Remarks
CH1 ... CH4 OnOff, Percent Sending an ON command will switch the dimmer to the value stored when last turning the dimmer off.

# Module vmb4an

Supported channels groups Supported channels Supported command types Remarks
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
analoginput CH9 ... CH12 Text
analoginput CH9Raw ... CH12Raw Number
analogOutput CH13 ... CH16 Percent

# Module vmbelpir

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH2 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
input CH9 Number
output output OnOff
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger

# Module vmbel4pir-20

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH4 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
input CH9 Number
output output OnOff
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger

# Modules vmbgp1

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
input CH9 Number
feedback CH1 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger

# Modules vmbel1, vmbel1-20

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
input CH9 Number
output output OnOff
feedback CH1 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger

# Modules vmbgp2

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
input CH9 Number
feedback CH1 ... CH2 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger

# Modules vmbel2, vmbel2-20

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
input CH9 Number
output output OnOff
feedback CH1 ... CH2 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger

# Modules vmbgp4, vmbgp4pir, vmbgp4pir-20

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
input CH9 Number
feedback CH1 ... CH4 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger

# Modules vmbel4, vmbel4-20

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
input CH9 Number
output output OnOff
feedback CH1 ... CH4 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger

# Modules vmbpiro, vmbpiro-10, vmbpiro-20

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH8 Pressed, Long_Pressed
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
input CH9 Number Temperature
input LIGHT Number
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number

# Modules vmbgpo, vmbgptc, vmbgpo-20, vmbgpod, vmbgpod-2

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH32 Pressed, Long_Pressed
input CH1 ... CH32 Pressed, Released, Long_Pressed Trigger
input CH33 Number Temperature
feedback CH1 ... CH32 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger
oledDisplay MEMO Text
oledDisplay SCREENSAVER OnOff

# Modules vmbelo, vmbelo-20

Supported channels groups Supported channels Supported command types Remarks
button CH1 ... CH32 Pressed, Long_Pressed
input CH1 ... CH32 Pressed, Released, Long_Pressed Trigger
input CH33 Number Temperature
output output OnOff
feedback CH1 ... CH32 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number
thermostat currentTemperatureSetpoint, heatingModeComfortTemperatureSetpoint, heatingModeDayTemperatureSetpoint, heatingModeNightTemperatureSetpoint, heatingModeAntiFrostTemperatureSetpoint, coolingModeComfortTemperatureSetpoint, coolingModeDayTemperatureSetpoint, coolingModeNightTemperatureSetpoint, coolingModeSafeTemperatureSetpoint, operatingMode, mode Number Min = -55, Max = 63.5, Step = 0.5
thermostat heater, boost, pump, cooler, alarm1, alarm2, alarm3, alarm4 Pressed, Released Trigger
oledDisplay MEMO Text
oledDisplay SCREENSAVER OnOff

# Module vmbmeteo

Supported channels groups Supported channels Supported command types Remarks
input CH1 ... CH8 Pressed, Released, Long_Pressed Trigger
weatherStation temperature, rainfall, illuminance, windspeed Number Steer the button LED feedback
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number

# Modules vmbpirc, vmbpirm, vmbpir-20

Supported channels groups Supported channels Supported command types Remarks
input CH1 ... CH7 Pressed, Released, Long_Pressed Trigger
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number

# Modules vmbdali, vmbdali-20

Supported channels groups Supported channels Supported command types Remarks
input CH1 ... CH81 Pressed, Released, Long_Pressed Trigger
feedback CH1 ... CH81 Clear_LED, Set_LED, Slow_Blink_LED, Fast_Blink_LED, Very_Fast_Blink_LED Steer the button LED feedback
color CH1 ... CH81 hsbColor CH1 ... CH64 = A1 ... A64 / CH65 ... CH80 = G1 ... G16 / CH81 = Broadcast
brightness CH1 ... CH81 Percent CH1 ... CH64 = A1 ... A64 / CH65 ... CH80 = G1 ... G16 / CH81 = Broadcast
white CH1 ... CH81 Percent CH1 ... CH64 = A1 ... A64 / CH65 ... CH80 = G1 ... G16 / CH81 = Broadcast
scene CH1 ... CH81 Number Min = 1, Max = 15, CH1 ... CH64 = A1 ... A64 / CH65 ... CH80 = G1 ... G16 / CH81 = Broadcast
virtual-light VL1 ... VL16 hsbColor Look at properties to group channels into a virtual light
clockAlarm clockAlarm1Enabled, clockAlarm2Enabled OnOff
clockAlarm clockAlarm1WakeupHour, clockAlarm1WakeupMinute, clockAlarm1BedtimeHour, clockAlarm1BedtimeMinute, clockAlarm2WakeupHour, clockAlarm2WakeupMinute, clockAlarm2BedtimeHour, clockAlarm2BedtimeMinute Number

# Module vmb4ledpwm-20

Supported channels groups Supported channels Supported command types Remarks
brightness CH1 ... CH4 OnOff, Percent Sending an ON command will switch the dimmer to the value stored when last turning the dimmer off.
fade-mode CH1 ... CH4 Direct, Fade_Rate, Fade_Time
scene CH1 ... CH4 Number Min = 1, Max = 15
virtual-light VL1 hsbColor Usable if mode = RGB or RGBW
dim-white DW1 Percent Usable if mode = RGB (=Dimmer channel) or RGBW (=White channel)

# Module vmb8dc-20

Supported channels groups Supported channels Supported command types Remarks
brightness CH1 ... CH8 Percent
fade-mode CH1 ... CH8 Direct, Fade_Rate, Fade_Time
scene CH1 ... CH8 Number Min = 1, Max = 15

# Module vmb2dc-20

Supported channels groups Supported channels Supported command types Remarks
brightness CH1 ... CH2 Percent
fade-mode CH1 ... CH2 Direct, Fade_Rate, Fade_Time
scene CH1 ... CH2 Number Min = 1, Max = 15

# Modules vmbpsumngr-20

Supported channels groups Supported channels Supported command types Remarks
input CH1 ... CH16 Pressed, Released Trigger

# Module vmbsig

Supported channels groups Supported channels Supported command types Remarks
N/A

# Modules vmbsig-20, vmbsig-21

Supported channels groups Supported channels Supported command types Remarks
status UNKNOWN, NORMAL, BUS_ERROR, LOW_POWER, HIGH_POWER String

The trigger channels can be used as a trigger to rules. The event message can be PRESSED, RELEASED or LONG_PRESSED for an input trigger.

The status channel for Signum modules is a String state channel (not a trigger) with possible values: UNKNOWN, NORMAL, BUS_ERROR, LOW_POWER, or HIGH_POWER.

To remove the state of the Item in the Sitemap for a button channel. Go to the Items list, select the Item, add a State Description Metadata, and set the Pattern value to a blank space.

# Full Example

.things:

Bridge velbus:bridge:1 [ port="COM1" ] {
    vmb2ble     01
    vmb2pbn     02
    vmb6pbn     03
    vmb8pbu     04
    vmb7in      05
    vmb4ryld    06
    vmb4dc      07
    vmbgp1      08
    vmbgp2      09
    vmbgp4      0A
    vmbgp4pir   0B
    vmbgpo      0C
    vmbgpod     0D
    vmbpiro     0E
}

.items:

Switch LivingRoom           { channel="velbus:vmb4ryld:1:06:CH1" }                # Switch for onOff type action
Switch KitchenButton        { channel="velbus:vmb2pbn:1:05:button#CH1" }          # Switch for Pressed and Long_Pressed type actions
Dimmer TVRoom               { channel="velbus:vmb4dc:1:07:CH2" }                  # Changing brightness dimmer type action
Rollershutter Kitchen       { channel="velbus:vmb2ble:1:01" }                     # Controlling rollershutter or blind type action

Number Temperature_LivingRoom "Temperature [%.1f °C]"     <temperature> { channel="velbus:vmbgp1:1:08:CH09" }
Number Temperature_Corridor   "Temperature [%.1f °C]"     <temperature> { channel="velbus:vmbgpo:1:0C:CH33" }
Number Temperature_Outside    "Temperature [%.1f °C]"     <temperature> { channel="velbus:vmbpiro:1:0E:CH09" }

.sitemap:

Switch item=LivingRoom
Slider item=TVRoom
Switch item=TVRoom          # allows switching dimmer item off or on
Rollershutter item=Kitchen

Switch item=KitchenButton # Press and Long_Pressed message are available
# or
Switch item=KitchenButton mappings=[PRESSED="Push"] # only the Pressed message is send on the bus
# or
Switch item=KitchenButton mappings=[LONG_PRESSED="Push"] # only the Long_Pressed message is send on the bus

Example trigger rule:

rule "example trigger rule"
when
    Channel 'velbus:vmb7in:1:05:input#CH5' triggered PRESSED
then
    var message = receivedEvent.getEvent()
    logInfo("velbusTriggerExample", "Message: {}", message)
    ...
end
Caught a mistake or want to contribute to the documentation? Edit this page on GitHub (opens new window)

← Velux →