MDAR Ltd edited this page Feb 6, 2018 · 53 revisions

This page describes Velbus support in OpenRemote V2.x.

Velbus is a proprietary protocol for fully wired building management and home automation modules from Velbus.eu

Introduction

The OpenRemote Velbus protocol has been created from the ground up and fully supports all current modules, with limited support for first generation modules. Velbus protocol version 1.1.0 contains these notable features:

  • Multi Network support, meaning multiple networks of (up to) 253 modules can be accessed via separate IP ports.
  • Velbus system time and date is updated every 6 hours, in addition to a manual time update command.
  • Full dynamic control over temperature set points (all 9 modes) within glass panels.
  • 0.1° current temperature resolution, if used with a custom sensor. Level sensor will show only whole values
  • Output module commands include time periods, for example Dim durations or Relay on duration.

The latest version of the protocol is velbus-1.3.2.jar as of Jan 2018
Please update to this latest version.

Place only this file in - ../webapps/controller/WEB-INF/lib/

Remove any other versions of this file and restart your controller.


OpenRemote uses TCP packets to communicate with a Velbus to TCP server.

Setup instructions for JVelbusD can be found here

  • VelServ Latest C+ code directly from the author has been on test for over 2 months here at MDAR. (Version 1.5) It is by far the easiest to set up and it appears to transfer the packets much quicker than other servers.

You will need to compile Velserv using GCC for your platform and set the parameters to start the server. The simplest command that uses default settings and sets the port to #6000 appears to be

sudo ./velserv -p 6000

Please read the readme.txt file in the zip for more information.

Untested Velbus TCP interfaces


Velbus support is available in Pro Designer and Controller version 2.5 and above,

Professional Designer offers unlimited modules.


Hardware

The following hardware is required for OpenRemote Velbus integration:

  • Velbus to TCP server, with an IP address and port number for each Velbus segment. Each of these servers require a separate USB or RS232 interface to communicate with a Velbus network. VMBRSUSB or VMB1USB -- Please note that VMBRSUSB modules have superior optoisolation and are recommended for longer cable runs.

Mulitple instances of Golfy's PB_Server have been tested successfully on a single Windows 7 machine, each with its own USB interface, outputting to a unique IP port. There is no reason why multiple instances of JVelbusD or VelServ couldn't be run on a single machine, but this has not been tested yet

Hardware compatibility table

'x' indicates a colour option that does not affect the capability of the module.

Modules are queried for their unique type during initialisation, non-compatible modules will not work in any way

Module Type Firmware Date tested Notes
VMBGPOx 1436 Aug 2015 Don't send too many commands too quickly, leave reasonable delays between commands.
VMBGPODx 1436 Aug 2015 Don't send too many commands too quickly, leave reasonable delays between commands.
VMBGP4x Oct 2016 Functions as expected
VMBGP4PIRx Oct 2016 Functions as expected
VMBGP2x 1349 Aug 2015 All commands function as expected
VMBGP1x 1347 Aug 2015 All commands function as expected
VMBGPOTCx Aug 2015 Not available for testing but all commands should function as expected
VMB8PBU 1350 July 2015 All commands function as expected
[_VMB8PB_] 0649 Aug 2015 Not compatible with current implementation - Can be included if there is demand at cost of £100
[_VMB6PB_] July 2015 Not compatible with current implementation - Can be included if there is demand at cost of £100
VMB1TS Jan 2017 Added to version 1.3.0
VMB7IN 1439 July 2015 All commands function as expected, Custom sensors seem to work better for energy values
[_VMB6IN_] 0649 Aug 2015 Not compatible with current implementation - Can be included if there is demand at cost of £100
[_VMB4PB_] 0743 Aug 2015 Not compatible with current implementation - Can be included if there is demand at cost of £100
VMBPIROx Oct 2016 Functions as expected
VMBPIRC Oct 2016 Functions as expected
VMBPIRM Oct 2016 Functions as expected
[_VMB1BL_] 0815 Aug 2015 Not compatible with current implementation - Can be included if there is demand at cost of £100
VMB2BLE 1325 July 2015 All commands performed as expected
[_VMB2BL_] 0815 Aug 2015 Not compatible with current implementation - Can be included if there is demand at cost of £100
VMB1BLS Aug 2015 Not available for testing but assured they perform as single channel version of VMB2BLE
[_VMB1DM_] July 2015 Not compatible with current implementation - Can be included if there is demand at cost of £100
[_VMB1LED_] July 2015 Not compatible with current implementation - Can be included if there is demand at cost of £100
[_VMB1DME_] 1046 Aug 2015 Not compatible with current implementation - Can be included if there is demand at cost of £100
VMBDMI 1201 July 2015 All commands function as expected, except ON command, use Dimmer_level:100 instead,
VMBDMI-R Aug 2015 This module was included in version 1.2.2 Jan 2017
VMB4DC 1327 July 2015 All commands function as expected, except ON command, use Dimmer_level:100 instead,
[_VMB4RY_] 0805 Aug 2015 Not compatible with current command set - Can be included if there is demand at cost of £100
VMB4RYLD 1327 July 2015 All commands performed as expected
VMB4RYNO 1327 July 2015 All commands performed as expected
VMB1RYNO 1325 July 2015 All commands performed as expected
VMB1RYNOS 1422 July 2015 All commands performed as expected
VMBMETEO Jan 2017 Added to version 1.3.0

Hardware Setup

Before you can include your Velbus modules in OpenRemote, please ensue you have a fully operational Velbus network. Paying attention to all of the guidance given in the

installation guide part 1

and installation guide part 2,

members of the team that have guided this OpenRemote integration were also involved in the development of the Velbus manuals in an attempt to streamline the installer and end user experience.

Although in theory it is possible to completely control a Velbus installation (including LED feedback) with OpenRemote, we would recommend that each Velbus network is fully programmed and is self sufficient.

This approach will reduce the amount of rules required in OpenRemote and ensures your Velbus network/s continue to function in the (unlikely) event of a server failure.

It is worth noting at this point that it is impossible for any Velbus module to communicate directly between different Velbus networks, this is both a hardware limitation and an intentional design feature.

However you could create rules in OpenRemote to monitor one Velbus network and trigger events on other Velbus networks. Or to trigger events within completely different device classes or vice versa.

For example the pressing of an 'ALL OFF' button on network 1 could trigger a macro to send OFF commands to modules on other Velbus networks, or mimick buttons on other networks that also have 'ALL OFF' actions assigned to them. Please be mindful of circular conditions if you choose to create such rules in OpenRemote


Configuration of Velbus intergration

We provide a pre-installed and unlimited Velbus implementation:

  • Log into your OpenRemote Designer account
  • If you are using a DIY box with your Designer account then download and install OpenRemote Designer controller distribution. The download link is located at the top-right corner of the Professional Designer User interface.

No additional installation steps are required, other than configuring your chosen Velbus to TCP server/s. The Professional Designer controller includes the Velbus protocol pre-installed and supports unlimited number of modules and networks.

OpenRemote Professional Designer

Which versions of OpenRemote contain the Velbus Protocol?

The Velbus protocol is only available in OpenRemote Pro version 2.5 and above.

Not to be confused with the Free / demo version of OpenRemote, which may have a higher version number.

MAC OS X Users

Currently we are not aware of a specific MAC OS Velbus to TCP server, an option might be to create a headless single board PC server. There are various threads on the Velbus forum which talk about these options.

The JVelbusD project is intended to be a multi platform TCP/IP server, please monitor the project website for more information.

Correct as of Aug 2015

April 2016

JVelbusD is now up and running on a number of Debian Linux machines. Because it is a Java application, it should work well with a MAC OS. If you test it, please make a comment at the bottom of this page, or in the forum.


Designer Configuration

To activate the OpenRemote Velbus implementation you need to modify the controller (Professional Designer is available at http://designer.openremote.com).

In the designer navigate to the "Building Modeler -> Config for Controller -> Velbus".

Here you can enter the IP addresses and respective port numbers of your Velbus servers.

Each Velbus command requires a numerical Network ID, starting at 1 (If no Network ID is specified, ID No.1 will be assumed)

Your IP addresses should be listed in a single text string, separated by a ';' (Semi-Colon)

For example; Network 1 might be served by a local server, with Networks 2 and 3 being served by 2 separate servers on another machine

IP Addresses 127.0.0.1;192.168.0.20;192.168.0.20

IP port numbers 8090;8090;8092

A simple single network loopback configuration might look like this

IP address 127.0.0.1

IP port 6000


Creating commands, sensors, switches & sliders

Create Velbus User Interface

Once you have a selection of Velbus command objects in your building modeler within OpenRemote Designer, you can start binding the Velbus objects to user interface elements. See the documentation on [User Interface Design] to learn how to bind building objects to user interface widgets.

Notes

  • Make sure your Velbus network/s are fully functional before integrating them with OpenRemote.
  • While the Velbus specification is in the public domain, the license associated with the software used in OpenRemote Pro V2.5 does not allow free distribution of the source code.

Velbus commands for different Velbus module types

This section assumes you've already read and completed the steps above.

This section describes the 61 commands that are available on the Velbus networks and how each command should be structured for their various subfunctions.

Please note that no one module supports all of the commands.

OpenRemote Designer Pro supports unlimited number of Velbus devices and networks, limited only by the processing power of your chosen server hardware.


Command structure

Read commands = read information from the Velbus modules that can be used within sensors.

Write commands = write information to the Velbus network.

A command for a Velbus module is created by giving it a name and selecting "Velbus" from the drop down list of protocols.

The window will expand to reveal the required attributes.

Velbus Attributes;

Module Address:- The DECIMAL version of the module base address 1 to 253

Command:- The drop down list contains all available commands, not all commands are valid in all modules.

Command Value:- Any additional text string that is required for that command.

Velbus Network:- The Velbus network ID will be entered here, starting from 1 (Blank = Network ID 1). Your network IDs will be incremental and correspond to the order that the networks are configured in your 'Velbus.Properties' file or OpenRemote configuration.

Velbus command #01

Velbus command #02


Relays

Relay Read Commands (x4)

Command Value Description Returns Notes
STATUS Channel Number (e.g. 1) Read channel status ON, OFF, N/A
SETTING_STATUS Channel number (e.g. 1) Read channel setting NORMAL, INHIBITED, FORCED, DISABLED, N/A
LED_STATUS Channel number (e.g. 1) Read channel LED status OFF, ON, SLOW, FAST, VERYFAST, N/A Fast indicated a short press timer is active, Slow indicates a Long press timer is active
LOCK_STATUS Channel number (e.g. 1) Read channel lock status ON, OFF, N/A

Relay Write Commands (x4)

Command Value Description
ON Channel number and optional duration in seconds separated by ':' (e.g. 1:60) Turn channel on for the specified period of time in seconds (if no time specified then it is turned on permanently)
OFF Channel number (e.g. 1) Turn channel off
LOCK Channel number and optional lock duration in seconds separated by ':' (e.g. 1:3600) Turn channel off and prevent it from being switched on for the specified period of time, if no duration is provided then it is permanently disabled
UNLOCK Channel number (e.g. 1) Enable channel

Input Devices

This group of commands covers all types of Velbus input device. Not all commands work with all input devices

Input Read Commands (x15)

Command Value Description Returns Notes
STATUS Channel number or temperature channel name (e.g. 1 or HEATER) Read channel status; possible channel numbers are 1-32 (depending on module) and possible temperature channel names are (HEATER, BOOST, PUMP, COOLER, ALARM1, ALARM2, ALARM3, ALARM4) RELEASED, PRESSED, LONG_PRESSED, N/A Use Sensor Type "Custom" as the return is a text string, use the returned text as a values in a custom sensor against sensor state names "on" & "off" to use with a switch. All input modules support channel status, but only Glass Panels (VMBGPxxxx) support temperature related status queries
LOCK_STATUS Channel number (e.g. 1) Read channel lock status, 'On' meaning the channel is locked, 'Off' meaning the channel is unlocked. ON, OFF, N/A
LED_STATUS Channel number (e.g. 1) Read channel LED status OFF, ON, SLOW, FAST, VERYFAST, N/A This is a read command that queries a particular section of the module's memory and is dependant on certain conditions. IF the feedback LED in question is working in 'normal' mode (See VelbusLink LED Feedback tab in Configure Module), this read command will initially return N/A, simply because the LED in question (within the module memory map) has not been sent a direct command, but the actual LED will be reflecting the state of any 'actions' it has been configured with.

LED status Once OpenRemote has sent a direct LED command, it will return that status, the actual LED will also continue to change state according to it's VelbusLink configuration, but the returned state will always be whatever the last direct LED command was that was sent to it from OpenRemote.

This could be useful if you wanted to use a 'Spare' button within a Velbus module to store a status, for use elsewhere in your Openremote project.

IF the LED in question is in Feedback mode, the actual LED will completely ignore any state command that OpenRemote sends it, however the module will return the state that the last command sent to that LED. Changing the LED mode to Monitoring will enable it to respond to commands from OpenRemote.

Command Value Description Returns Notes Compatible Modules
ALARM_STATUS Alarm number (e.g. 1) Read wake and bedtime alarm status (Enabled or Disabled) ON, OFF, N/A
ALARM_TYPE_STATUS Alarm number ( 1 or 2) Read alarm type status (e.g. master (global) or local) LOCAL, MASTER, N/A This read command is only for display / reminder purposes to show that any changes to an alarm time will affect all modules in the Velbus Network (or segment if multiple networks are configured) that share the master / global alarm.
ALARM_TIME_STATUS Alarm type (Options are: 1:WAKE, 1:BED, 2:WAKE & 2:BED) Read specified alarm set time string date in HH:mm format (e.g. 20:00)
SUNRISE_STATUS Read sunrise status ON, OFF, N/A
SUNSET_STATUS Read sunset status ON, OFF, N/A
PROGRAM_STATUS Read active program NONE(0), SUMMER(1), WINTER(2), HOLIDAY(3), N/A
TEMP_STATUS Read current temperature without units double with resolution of 0.1oC (e.g. 19.3) , N/A 0.1° resolution only displayed when using Custom sensors, Level sensors will display whole values Only for use with modules with temperature capabilities.
TEMP_TARGET_STATUS Blank for current target temperature or optionally the temperature mode to read (HEAT_COMFORT, HEAT_DAY, HEAT_NIGHT, HEAT_SAFE, COOL_SAFE, COOL_NIGHT, COOL_DAY & COOL_COMFORT) Read either current or specified temperature mode target temperature without units double with resolution of 0.5oC (e.g. 19.5) , N/A Only for modules with thermostat functionality
TEMP_STATE_STATUS Read current state of the temperature module; normal = temperature program steps execute when specified, disabled = thermostat disabled, manual = program steps ignored and module is permanently in current mode, timer = program steps ignored until current sleep timer expires NORMAL. DISABLED, MANUAL, TIMER, N/A Only for modules with thermostat functionality

TEMP_STATE_STATUS is affected by:-

'TEMP_MODE', when used with a time value sets this status to 'Timer'

'LOCK' Command, changes the status to 'Disabled'

'UNLOCK' command releases the 'Disabled' mode, but will not release from a 'Timer' state, to release a 'Timer' state you must send the thermostat another 'TEMP_MODE' command, without a time value.

Setting a Temp_Mode with -1 as time value will but the thermostat into Manual Mode.

Curiously, when the Thermostat is in the 'Disabled' state, it also sets TEMP_MODE_STATUS to 'Heat_Safe' mode.

Command Value Description Returns Notes Compatible Modules
TEMP_MODE_STATUS Read active temperature mode COOL_COMFORT, COOL_DAY, COOL_NIGHT, COOL_SAFE, HEAT_COMFORT, HEAT_DAY, HEAT_NIGHT, HEAT_SAFE, N/A Only for modules with thermostat functionality
COUNTER_STATUS Channel number or function (wind, rain or light) : optional multipler (e.g. 1 or 2:0.536 or wind:0.12345) Read counter channel cumulative value Counter value to 2DP (e.g. 1234.56) Only relevant to counter or energy monitors and METEO
COUNTER_INSTANT_STATUS Channel number or function (wind, rain or light) : optional multipler (e.g. 1 or 2:0.536 or wind:0.12345 Read counter channel instantaneous value Instantaneous value to 2DP (e.g. 1234.56) Only relevant to counter or energy monitors and METEO

Input Write Commands (x16)

Command Value Description Notes Compatible Modules
TIME_UPDATE Sends a global time & date update to the Velbus network. This is the only command that does not require a Module base address (but it does require a random address between 1 and 253), as it is a global command, it also requires a Network ID. To update all networks you are required to create a macro to fire separate commands into each Velbus network ID. All modules that hold the current time
PRESS Channel number (e.g. 1 to 8, or 32 for GPO) Simulate a push button press on the specified channel
LONG_PRESS Channel number (e.g. 1 to 8, or 32 for GPO) Simulate a push button long press on the specified channel
RELEASE Channel number (e.g. 1 to 8, or 32 for GPO) Simulate a push button release on the specified channel

The three commands above are needed separately in order to fully support the Velbus protocol. So in order for your Velbus system to perform as expected you shouldn't just use a Press command within a user interface if you are trying to mimic a button press. You should create a macro for each button you want to mimic, for standard presses, or long presses. The macro should contain the button press command, a delay (25ms is normal for a button press) and a release command. There is a button widget operational change currently being planned (July 2015) which will facilitate a command when pressed and a command when released. This will mean that 'press and hold' dimming will be possible with Long_Press & Release commands, or momentary relay closures with the Press & Release combination.

Command Value Description Returns Notes Compatible Modules
LOCK Channel number and optional lock duration in seconds separated by ':' (e.g. 1:3600) Lock channel and prevent it from being activated for the specified period of time, if no duration is provided then it is permanently disabled; if channel is max channel number + 1 (e.g. 9 or 33) then the thermostat is locked (if supported)
UNLOCK Channel number (e.g. 1 to 8, or 32 for GPO) Unlock channel; if channel is max channel number + 1 (e.g. 9 or 33) then the thermostat is unlocked (if supported)
LED Channel number and LED state separated by ':' (e.g. 1:OFF) Set the LED state for the specified channel; possible LED states are OFF, ON, SLOW, FAST, VERYFAST This command only affects the LED state if the LED mode has been set to MONITOR, otherwise the set state is only stored in the module's memory.
TEMP_TARGET COOL_SAFE, COOL_NIGHT, COOL_DAY, COOL_ COMFORT, HEAT_SAFE, HEAT_NIGHT, HEAT_DAY, HEAT_COMFORT,CURRENT, separated by ':' (e.g. COOL_COMFORT:20.0) [IF USED WITH A SLIDER THEN THE NEW TARGET TEMPERATURE WILL BE TAKEN FROM THE SLIDER VALUE] Sets the target temperature for the specified temperature mode; possible temperature modes are all values returned from TEMP_MODE_STATUS and additionally CURRENT which changes the current target temperature. Changes to mode target temperatures are permanent except for CURRENT which is only valid until the active temperature mode changes. Only modules with thermostat functionality
TEMP_TARGET_RELATIVE Temperature mode to set and new relative target temperature separated by ':' (e.g. COOL_COMFORT:-0.5) Sets the target temperature relative to the current value for the specified temperature mode; possible temperature modes are all values returned from TEMP_MODE_STATUS and additionally CURRENT which changes the current target temperature. Changes to mode target temperatures are permanent except for CURRENT which is only valid until the active temperature mode changes Only modules with thermostat functionality
TEMP_MODE Temperature mode to set and optional duration to set it for in minutes separated by ':' (e.g. COOL_SAFE:20160) Sets the current temperature mode, if no duration is specified then the change is only effective until the next time a program step changes the mode, if a duration value of -1 is used then the change is permanent Program steps will be disabled i.e. manual mode, otherwise program steps to change mode will be ignored for the duration specified ; possible temperature modes are all values returned from TEMP_MODE_STATUS
ALARM Alarm number, alarm type and new status separated by ':' (e.g. 1:MASTER:ON) Set alarm status; possible alarm type values are MASTER or LOCAL; possible alarm number values are 1 or 2; possible status values are ON or OFF Master alarm changes can be sent to any module as it will affect all modules on the bus that are in master alarm mode
ALARM_TIME Alarm number, alarm time type and new time in minutes past midnight separated by ':' (e.g.1:WAKE:340) Sets the time for the specified alarm; possible values for alarm time type are WAKE or BED; possible values for alarm number are 1 or 2; possible values for time are 0-1439 Master alarm changes can be sent to any module as it will affect all modules on the bus that are in master alarm mode. This is a dynamic command that will accept values from a slider

The ALARM_TIME command will alter either the LOCAL or MASTER alarm time depending on which of the two modes this alarm is set to (it is not possible to specify the alarm type as there is no way of reading the time for both alarm types, as the time is the same, with only a bit set for master or local)

Sliders can inject values into this command. A range sensor is required with a minimum value of 0 and a maximum value of 1439

Likewise, reduced ranges can be set to limit the user's options.

Formula for alarm times in minutes:

Given that 24 hours have 1439 unique minutes, the easiest way to work out the alarm time in minutes is to use a simple spreadsheet that works out; (Hour x 60 minutes) + minutes past the hour

A B Expected Result
1 Whole minutes in a day 1440 1440
2 Required alarm time 07:30 07:30
3 Alarm time in minutes =B1*B2 450
4 Check hour =Rounddown(B3/60,0) 7
5 Check minutes =B3-(B4*60) 30
24 Hr time Time in mins 24 Hr time Time in mins
00:00 0 20:47 1247
06:30 390 21:15 1275
08:30 510 22:30 1350
19:00 1140 23:59 1439
Command Value Description Notes Compatible modules
ALARM_TIME_RELATIVE Alarm number, alarm time type and change of time in minutes relative to current time separated by ':' (e.g. 1:wake:-5 or 2 : bed : 120) Sets the time for the specified alarm relative to the current value; possible values for the alarm number are 1 or 2; possible values for alarm time type are 'wake' or 'bed' This will alter the LOCAL or MASTER alarm time depending on which of the two modes this alarm is set to (it is not possible to set different times for Local or Master as the time is the same for each alarm, with just a bit set for master or local)

It is best practise to use VelbusLink to define Master alarm groups, then only incorporate alarm time changes for a single Master alarm module in an OpenRemote controller.

Dynamic time setting can be achieved by creating a grid which displays the alarm time in the middle and a selection of incrementing and decrementing ALARM_TIME_RELATIVE commands. I.E. +1 min, -5 min, +60 min, +180 min (3 hours)

Command Value Description Notes Compatible modules
MEMO_TEXT String to use as memo text (maximum of 63 characters) and optional duration to display in seconds separated by ':' (e.g. TEST MESSAGE:5 Sets the memo text on an OLED touch panel for the specified period of time; if no duration is provided then a default of 5 seconds is used. This is a dynamic command that well accept a text string from a Drule, so can be used to display information on an OLED panel from other sources If you must send a string longer than 63 characters, you will have to create a macro to send each memo_text command. Each single MEMO_TEXT string will scroll until the next command is sent, or the Velbus protocol in OpenRemote times out and sends the clear command, which is a completely blank MEMO_TEXT string Only OLED variants of glass panels. VMBGPOxxx
LANGUAGE ENGLISH, FRANCAIS, NEDERLANDS, ESPANOL, DEUTSCH, ITALIANO Sets the system display language of the OLED panel (Used when the panel is in programming mode, normally done by pressing the lower middle divider when it is displaying either, Clock, Temperatures or Energy Only OLED variants of glass panels. VMBGPOxxx
PROGRAM NONE or 0, SUMMER or 1, WINTER or 2, HOLIDAY or 3 Used to set the active program group within each module Remember that program groups are unique to each module. However, you can create a macro if you want all (or selections of) modules to change

Dimmers and 0-10v controller

Tested with;

VMBDMI

VMB4DC

VMBDMI-R

Dimmer Read Commands (x5)

Command Value Description Returns Notes
STATUS Channel number (e.g. 1) Read channel status ON, OFF, N/A Not all dimmer modules support this command
DIMMER_STATUS Channel number (e.g. 1) Read dimmer channel level value Dimmer value percentage (0-100)
SETTING_STATUS Channel number (e.g. 1) Read channel setting NORMAL, INHIBITED, FORCED, DISABLED, N/A
LED_STATUS Channel number (e.g. 1) Read channel LED status OFF, ON, SLOW, FAST, VERYFAST, N/A OFF & ON are self explanatory, SLOW means that there is a timer in play, FAST means that the dimmer is Dimming. The LED will return ON at any stage if it is not changing the dim level or OFF.
LOCK_STATUS Channel number (e.g. 1) Read channel lock status ON, OFF, N/A

Dimmer Write Commands (x6)

Command Value Description Notes
OFF Channel number (e.g. 1) Turn channel off
DIMMER_LEVEL Channel number, dim level to set as percentage (0-100) and optional duration in seconds to reach this level separated by ':' (e.g. 1:50:5) [IF USED WITH A SLIDER THEN THE DIM LEVEL WILL BE TAKEN FROM THE SLIDER VALUE] Set channel dim level to the specified value in the specified time in seconds (if no time specified then a default of 1 second is used) Try to avoid using this command with a button as it may start to behave like a memory On function (we are looking into why. July 2015)
HALT Channel number (e.g. 1) Stop channel dimming if in progress
LOCK Channel number and optional lock duration in seconds separated by ':' (e.g. 1:3600) Turn channel off and prevent it from being switched on for the specified period of time, if no duration is provided then it is permanently disabled
UNLOCK Channel number (e.g. 1) Enable channel

Blinds

Blinds Read Commands (x4)

Command Value Description Returns Notes
STATUS Channel number (e.g. 1) Read blind channel status HALT, UP, DOWN, N/A
POSITION_STATUS Channel number (e.g. 1) Read blind channel position status 0-100, N/A
SETTING_STATUS Channel number (e.g. 1) Read channel setting NORMAL, INHIBITED, FORCED, DISABLED, N/A
LOCK_STATUS Channel number (e.g. 1) Read channel lock status ON, OFF, N/A

Blinds Write Commands (x6)

Command Value Description Notes
BLIND_POSITION Channel number and optional position value (e.g. 1:100) [IF USED WITH A SLIDER THEN THE POSITION WILL BE TAKEN FROM THE SLIDER VALUE] Set blind channel position, accepts value between 0-100
UP Channel number and optional duration to keep up relay active separated by ':' (e.g. 1:10) Move blind channel up for optional duration; if no time is specified then the default timeout is used
DOWN Channel number and optional duration to keep down relay active separated by ':' (e.g. 1:10) Move blind channel down for optional duration; if no time is specified then the default timeout is used
HALT Channel number (e.g. 1) Halt the specified blind channel (i.e. turn off both up and down relays)
LOCK Channel number and optional lock duration in seconds separated by ':' (e.g. 1:3600) Turn channel off and prevent it from being switched on for the specified period of time, if no duration is provided then it is permanently disabled
UNLOCK Channel number (e.g. 1) Enable channel

Full list of commands for modules

A full list of commands for each currently supported module is in a spreadsheet.

As new modules are released, profiles will be added to this spreadsheet and the import tool.

Command spreadsheet Velbus Command XLS


Import wizard for Velbus Devices

This article describes how the import wizard process for Velbus devices is setup using the Professional Designer based on a fresh design.

Note: This functionality is not yet available in the Professional Designer.

Funding issue

Currently the Velbus import wizard is under development, so the following text is only an outline of what will be possible.

As of Aug 2015, the budget to complete the import tool has been estimated at €3,600, if nobody else offers to assist in covering this fee, it will be paid by MDAR Ltd. However it will have to be set aside from the profits from the sale of Velbus hardware.

So in short, the more people that buy Velbus products from MDAR, the sooner the import wizard will be available in the Pro Designer

If you wish to help with the funding of the import tool, please email MDAR directly importwizard@mdar.eu or contact the OpenRemote team.

Import wizard outline

The import wizard enables VelbusLink configuration files to be uploaded into the online designer in order to automatically create the hundreds of commands, sensors, sliders and switches that can be used in a user interface.

The wizard will detect the module types and firmware versions in each network segment and provide a tool to create commands, if the module has an associated profile.

For example, although a module type might be supported, its firmware version may not be in the known range. [This is a known issue with older firmware versions, or latest release versions that require different commands]

Once a module has been confirmed as compatible, the various names and base address' will be extracted from the VLP file and used during the command creation process.

Import profiles

  • Basic

The basic profile for each module is designed to give all the functions required for an A-typical interface.

-- Button status for the first 8 buttons of an input module. -- Basic temperature values and target / mode changes -- Energy monitoring -- Simple controls for dimmers, relays, blind / motor controllers and other output modules -- Simple alarm time sensors and time setting commands

  • Complete

As the name would suggest, the complete profile creates every command, sensor, switch or slider that each module supports.

While this is an exhaustive list of commands, it is probably best to be absolutely sure you need all the commands before selecting this profile for importing. Before deploying your design in full, it is advisable to delete any unused sensors to reduce processor load. The cpu load per sensor is minimal, but may affect the performance of your controller.

  • BMS (Building Management System)

The BMS profile has been created to assist in incorporating multiple Velbus networks into a single controller, where only key information is required.

-- Heating / cooling demand -- Current temperatures and current target temperatures -- Energy monitoring -- Button status for a small selection, so that they can be easily adjusted for specific buttons. -- Status of output modules and presence detectors

Full list of commands for modules

A full list of commands for each currently supported module is in a spreadsheet.

As new modules are released, profiles will be added to this spreadsheet and the import tool.

Command spreadsheet

Import process

(Awaiting text)

Prerequisites

(Awaiting text)

VelbusLink configuration file

(Awaiting text)

Network connection parameters

Enter the server hostname (or IP address) and port number

Starting the wizard

Set Network ID

Define the network ID for the imported configuration

Upload VLP file

Upload the VelbusLink VLP file for the network yo> u are importing

Select import profile

Choose which set of commands you wish the import tool to prepare for you

Complete import

See Also


Automating a building takes skill, animating a human takes cunning


Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.