Эта страница является
переводом страницы
Helvar. Перевод выполнен на 100%.
iRidium for Helvar
a set of tools for creating interfaces for controlling Helvar equipment
The documentation was updated on 06.10.2023
Description
iRidium for Helvar - is a set of tools for creating interfaces to control lighting on the basis of Helvar equipment.
You can connect to Helvar using different ways (drivers): HelvarNet (TCP), HelvarNet (UDP), HelvarNet Internal (UDP), Helvar AV (RS232).
Make sure your Helvar router supports the HelvarNet protocol. Otherwise you need to update the software and firmware
For connection via IP use DIGIDIM 910/920
iRidium licensing for Helvar (more).
Connection
Equipment configuration and settings required for iRidium to control Helvar.
Ways of connection to Helvar
Helvar drivers have special features which have to be considered when selecting the way of control:
Local connection:
HelvarNet (TCP), HelvarNet (UDP), HelvarNet Internal (UDP), HelvarAV (RS232)
Internet connection:
HelvarNet (TCP)
- HelvarNet (TCP)
- supports Site licensing
- updates the device status by requests from control panels
- supports 1 connection in the local network
- supports 1 connection via the Internet
- HelvarNet (UDP)
- supports Site licensing
- updates the device status by requests from control panels
- gets only the changes requested by control panels
- supports several connections in the local network
- does not support connection via the Internet
- HelvarNet Internal (UDP)
- uses broadcasting - UDP broadcasting within the segment of the IP network
- does NOT support Site licensing
- information about the state change comes without forced requests ** supports several connections in the local network
- does not support connection via the Internet
- Helvar AV (RS232)
- uses the RS232 transport for connection to DALI
- does NOT support Site licensing
- supports 1 connection in the local network
- does not support connection via the Internet
Importing the Helvar driver to iRidium
Import allows you to upload a file in csv format from the Designer app and add it to the project. It is the fastest and convenient way to add a driver to the project. All commands and feedbacks, that were uploaded to the project, have the preset settings, which you can change if it is necessary.
To import:
1 Open the Designer app and go to Tools > Grouping Report...
2 Generate a group report:
3 Go to the Reports tab and click right mouse button on the report, open the menu and press Save As button:
4 Go to iRidium Studio and press the Scanner / Import button, then choose the Import Helvar (*.csv) option.
5 Select the required file in csv format.
6 Select all required devices to import.
7 You see the driver with commands and feedbacks, divided into folders.
Adding the Helvar driver manually
In addition to importing you can add and set the Helvar driver manually:
Setting up connection to Helvar
Select the driver and connection settings by default. They can be changed while working with the project.
- Host - the router IP-address in the local network (or the router public IP-address)
- Port - the port of connection to the router (TCP / UDP). It is always 50000 for TCP. It is always 50001 for UDP.
To work via the Internet, indicate the public IP-address of the router to which the controller is connected and set up Port Forwarding.
You can see the public IP-address of the router here
Change of connection settings
You need the possibility to change connection properties when you disconnect from the Wi-Fi network of the automation object and start using 3G or another Wi-Fi network. To maintain control of the object you need to switch from the local to public IP-address of the Internet router.
The switch is not automatic. You have to select the connection mode. For remote acces you have to make ports for controlling the automation system public. In order to do that you have o set up the Port Forwarding service on your Internet router. VPN can provide protected connection.
1 Download the template (*.js) (right-click button: "Save object as ..."), add the template in the script editor with the button
(+) Add Script from file
2 Set up script properties as it is shown in the example:
- function Internal_1() {
- IR.GetDevice("HelvarNet (TCP)").SetParameters({Host: "10.254.1.2", Port: 50000});
- }
- function External_1() {
- IR.GetDevice("HelvarNet (TCP)").SetParameters({Host: "215.110.10.10", Port: 50000});
- }
Copy the driver name from Projeсt Device Panel - the list of properties has to be copied from the example.
3 Select the button which will be responsible for the switch of Internal and External properties. Open Macros Editor for the Press event (Object Properties > Programming), select the Script Call command and add it by double-clicking on it. Select the name of the function which will be activated by the button:
Now each pressing on the button will apply the corresponding connection properties.
Control of equipment
To control equipment it is required to set commands (Commands) and feedback channels (Feedbacks). To send a command, drag'n'drop it on a graphic item and enter a value to send. To display feedback value drag'n'drop a feedback channel on a graphic item and choose how to output a value.
Read more about work with graphic items in the
"Types of graphic items" article.
Possible settings of commands, channels and graphic items are presented below:
Direct Level, Query Load Level
Direct Level is used to turn on/turn off/ set up brightness of a device (Device) or group(Group).
Query Load Level is a feedback channel which regularly requests the status of the controlled device (Device) and sends it to the interface.
Command (Direct Level Device):
| Command |
Direct Level Device |
to set up the device state (on/off/brightness)
|
| Cluster |
1...253 |
the device address (@ address)
|
| Router |
1...254 |
the device address (@ address)
|
| Subnet |
1...4 |
the device address (@ address)
|
| Device |
1...255 |
the device address (@ address)
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value * |
0...100 |
the preset brightness value
|
Command (Direct Level Group):
| Command |
Direct Level Group |
to set up the device state (on/off/brightness)
|
| Group |
1...16383 |
the group address in the Helvar system
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value * |
0...100 |
the preset brightness value
|
* Value - indicate when dragging the command on graphic items. In the Helvar system the range for any device is 0 ~ 100 but dimmers do not process all values of the range and relays react on zero and non-zero values. At that for relays there is "trip limit" and if you send the value less than the limit relays will not work. The settings are formed in the process of Helvar configuration.
Feedback (Query Load Level):
| Command |
Query Load Level |
to request and display the device state (brightness). For Device only
|
| Cluster |
1...253 |
the device address (@ address)
|
| Router |
1...254 |
the device address (@ address)
|
| Subnet |
1...4 |
the device address (@ address)
|
| Device |
1...255 |
the device address (@ address)
|
| Use Timer |
Yes/No |
to request the device status on timer (HelvarNet does not give the status without requests). If the timer is off the device status will not be received.
|
| Timer |
0...n |
(ms) the frequency of requesting the device status
|
| Value * |
0...100 |
the current value of device brightness
|
* Value - comes to the feedback channel, use it for displaying on items
Recall Scene
Use the "Recall Scene Device / Group" command to activate the scene programmed for the device or the device group in the Helvar system.
The command for scene activation can be directed on loads only (dimmers, relay units, ...):
Command (Recall Scene Device):
| Command |
Recall Scene Device |
to activate the scene for the device
|
| Cluster |
1...253 |
the device address (@ address)
|
| Router |
1...254 |
the device address (@ address)
|
| Subnet |
1...4 |
the device address (@ address)
|
| Device |
1...255 |
the device address (@ address)
|
| CL |
0...1 |
Constant Light: 1 = On, 0 = Off
|
| Block |
1...8 |
the block number, "Scene 1.2" = block 1 scene 2 (see Helvar Designer).
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value * |
1...n |
the scene number
|
Command (Recall Scene Group):
| Command |
Recall Scene Group |
to activate the scene for the group of devices
|
| Group |
1...16383 |
the group address in the Helvar system
|
| CL |
0...1 |
Constant Light: 1 = On, 0 = Off
|
| Block |
1...8 |
the block number, "Scene 1.2" = block 1 scene 2 (see Helvar Designer).
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value * |
1...n |
the scene number
|
* Value - indicate when dragging the command on graphic items
Feedback:
You cannot receive information about which scene is activated at the moment.
Direct Proportion
Setting up proportions. When using "Direct Proportion" the set up value is calculated as difference between the last value (set by a scene or directly) and the maximum output device level.
Command (Direct Proportion Device):
| Command |
Direct Proportion Device |
to set up the proportion for the device
|
| Cluster |
1...253 |
the device address (@ address)
|
| Router |
1...254 |
the device address (@ address)
|
| Subnet |
1...4 |
the device address (@ address)
|
| Device |
1...255 |
the device address (@ address)
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value * |
0...100 |
the proportion value
|
Command (Direct Proportion Group):
| Command |
Direct Proportion Group |
to set up the proportion for the group
|
| Group |
1...16383 |
the group address in the Helvar system
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value * |
0...100 |
the proportion value
|
*Value - indicate when dragging the command on graphic items.
Feedback:
The current device state comes to Query Load Level
How to calculate the proportion value
The result of writing the positive proportion: if the last scene set 44% brightness and you will write 50 in "Direct Proportion Device", the result brightness will be 72%:
44 + (100 - 44)*50/100 = 72%
The result of writing the negative proportion: if the last scene set 44% brightness and you will write -50 in "Direct Proportion Device", the result brightness will be 22%:
44*50/100 = 22%
Modify Proportion
Proportion modification. Results can be calculated using "Proportion" formulas. But "Modify Proportion" affects the value of the proportion and not the result. So to 50% added via "Direct Proportion" we can add 5% via "Modify Proportion" (total 55%) and get the result of the initial formula.
Command (Modify Proportion Device):
| Command |
Modify Proportion Device |
to modify the proportion for the device
|
| Cluster |
1...253 |
the device address (@ address)
|
| Router |
1...254 |
the device address (@ address)
|
| Subnet |
1...4 |
the device address (@ address)
|
| Device |
1...255 |
the device address (@ address)
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value * |
0...100 |
the proportion value
|
Command (Modify Proportion Group):
| Command |
Modify Proportion Group |
to set up the proportion for the group
|
| Group |
1...16383 |
the group address in the Helvar system
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value * |
0...100 |
the proportion value
|
*Value - indicate when dragging the command on graphic items.
Feedback:
The current device value comes to Query Load Level
How to modify the proportion value
The result of writing the positive modification: on the example of the "Direct Proportion" command described in the previous section. When the command is sent, the next proportion modification by 5% will give 75% brightness as it is applied to the previous value of "Direct Proportion":
44 + (100 - 44)*(50 + 5)/100 = 75%
The result of writing the negative modification: on the example of the "Direct Proportion" command described in the previous section. When the command is sent, the next proportion modification by -5% will give 19% brightness as it is applied to the previous value of "Direct Proportion":
44*(50 - 5)/100 = 19%
Emergency Test Control Commands
"Emergency Function Test Device" and "Emergency Duration Test Device" - requests for the emergency state for sending to DALI interfaces only. There will not be any response from non-emergency devices of the system.
Command (Device):
| Command |
Emergency Function Test Device |
the request for the device emergency functions
|
| Emergency Duration Test Device |
the request for the duration of the emergency state
|
| Stop Emergency Tests Device |
to stop all emergency testing
|
| Cluster |
1...253 |
the device address (@ address)
|
| Router |
1...254 |
the device address (@ address)
|
| Subnet |
1...4 |
the device address (@ address)
|
| Device |
1...255 |
the device address (@ address)
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value * |
- |
it is not used - input 0 or leave empty
|
Command (Group):
| Command |
Emergency Function Test Device |
the request for the DALI emergency functions
|
| Emergency Duration Test Device |
the request for the duration of the emergency state
|
| Stop Emergency Tests Device |
to stop all emergency testing
|
| Group |
1...16383 |
the address of the group of devices in the Helvar system
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value |
0...100 |
it is not used - input 0 or leave empty
|
Feedback (Device):
| Command |
Emergency Function Test Device |
the emergencies of the DALI device
|
| Emergency Duration Test Device |
the request for the duration of the emergency state
|
| Cluster |
1...253 |
the device address (@ address)
|
| Router |
1...254 |
the device address (@ address)
|
| Subnet |
1...4 |
the device address (@ address)
|
| Device |
1...255 |
the device address (@ address)
|
| Fade Time |
0...6553.5*10^3 |
(ms) the speed of switching the status from current to the preset one
|
| Value |
0...n |
the current state
|
Feedback (Group):
| Command |
Emergency Function Test Device |
the emergencies of the DALI device
|
| Emergency Duration Test Device |
the request for the duration of the emergency state
|
| Group |
1...16383 |
the address of the group of devices in the Helvar system
|
| Value |
0...n |
the current state
|
Query Commands
Requests for the device status in the Helvar system are formed in the Feedbacks tab and are activated in a cycle with an interval which can be set in the Timer property.
If the selected protocol of work with Helvar supports auto-notifications about the changes of system statuses, then create Feedback without timer.
Feedback:
| Command |
General Query Commands
|
| Query Clusters |
all identifiers of items (Cluster Member) from the cluster
|
| Query Routers |
all identifiers in the indicated cluster
|
| LSIB - Last Scene In Block |
the last activated scene of the indicated block
|
| Query Device Type |
the type of the device to which the request is sent. 1 - DALI, 2 - Digidim, 4 - SDIM, 8 - DMX
|
| Query Description |
the device/group description
|
| Device State Query Commands
|
| Query Device State |
the device flags (properties) - the list
|
| Query Device Is Disabled |
disabling of the device
|
| Query Lamp Failure |
failure of the lamp
|
| Query Device Is Missing |
non-availability of the device
|
| Query Device Is Faulty |
failure of the device
|
| Query Emergency Battery Failure |
failure of the emergency battery
|
| Measurement / Input / Level Query Commands
|
| Query Measurement |
changing of the analog property, for example, light (Analogue Input Unit)
|
| Query Inputs |
thee state of the digital input
|
| Query Load Level |
the device status
|
| Power Consumption Query Commands
|
| Query Power Consumption |
device power consumption
|
| Query Group Power Consumption |
power consumption of all devices in the group
|
| Emergency Test Query Commands
|
| Query Emergency Function Test Time |
the time of the emergency testing
|
| Query Emergency Function Test State |
the status of the emergency testing. Pass - 0, Lamp Failure - 1, Battery Failure - 2, Faulty - 4, Failure - 8, Test Pending - 16, Unknown - 32
|
| Query Emergency Duration Test Time |
the duration of the emergency testing
|
| Query Emergency Duration Test State |
the duration of the emergency state
|
| Query Emergency Battery Charge |
the remaining charge of the emergency battery
|
| Query Emergency Battery Time |
the total work time of the emergency battery
|
| Query Emergency Total Lamp Time |
the total work time of the lamp from any power source
|
| System Query Commands
|
| Query Time, Longitude, Latitude, Time Zone, Daylight Saving Time, Software Version, HelvarNet Version |
the system properties
|
| Cluster |
1...253 |
the device address (@ address)
|
| Router |
1...254 |
the device address (@ address)
|
| Subnet |
1...4 |
the device address (@ address)
|
| Device |
1...255 |
the device address (@ address)
|
| Use Timer |
Yes/No |
the request for the device status on timer (HelvarNet does not five the status without requests). If the timer is off then the device status cannot be received.
|
| Timer |
0...n |
(ms) the frequency of requests for the device status
|
| Subdevice |
1...255 |
the subdevice address
|
| Value * |
0...100 |
the current property value
|
* Value - comes to the feedback channel, use it for displaying on items
Processing the Query Load Color command of protocol versions 1 and 2 are supported.
Query Device State
Each device from the Helvar system of controlling lighting can give information about some of its properties (flags) by request. It can be used when monitoring the state of the lighting system.
To display the device flags, create the feedback channel. In its settings indicate the device address and the frequency of requesting the flag. The channel is assigned to the graphic item which will display the flag status (0 - not active, 1 - active):
Feedback:
| Command |
Query Device State |
to request the state of the device property
|
| Command Property |
Disabled |
Device or subdevice has been disabled, usually an IR subdevice or a DMX channel
|
| Lamp Failure |
Unspecified lamp problem
|
| Missing |
The device previously existed but is not currently present
|
| Faulty |
Ran out of addresses (DALI subnet) / unknown Digidim control device / DALI load that keeps responding with multi-replies
|
| Refreshing |
DALI subnet, DALI load or Digidim control device is being discovered
|
| Resting |
Load is intentionally off whilst the control gear is being powered by the emergency supply
|
| Reserved |
|
| In Emergency |
No mains power is being supplied
|
| In Prolong |
Mains has been restored but device is still using the emergency supply
|
| FT In Progress |
The Functional Test is in progress (brief test where the control gear is being powered by the emergency supply)
|
| DT In Progress |
The Duration Test is in progress. This test involves operating the control gear using the battery until the battery is completely discharged. The duration that the control gear was operational for is recorded, and then the battery recharges itself from the mains supply
|
| DT Pending |
The Duration Test has been requested but has not yet commenced. The test can be delayed if the battery is not fully charged
|
| FT Pending |
The Functional Test has been requested but has not yet commenced. The test can be delayed if there is not enough charge in the battery
|
| Battery Fail |
Battery has failed
|
| In Hi Bit |
Prevents an emergency fitting from going into emergency mode
|
| FT Requested |
Emergency Function Test has been requested
|
| DT Requested |
Emergency Duration Test has been requested
|
| Unknown |
Initial state of an emergency fitting
|
| Over Temperature |
Load is over temperature/heating
|
| Over Current |
Too much current is being drawn by the load
|
| Comms Error |
Communications error
|
| Severe Error |
Indicates that a load is either over temperature or drawing too much current, or both
|
| Bad Reply |
Indicates that a reply to a query was malformed
|
| Device Mismatch |
The actual load type does not match the expected type
|
| Cluster |
1...253 |
the device address (@ address)
|
| Router |
1...254 |
the device address (@ address)
|
| Subnet |
1...4 |
the device address (@ address)
|
| Device |
1...255 |
the device address (@ address)
|
| Use Timer |
Yes/No |
the request for the device status on timer (HelvarNet does not five the status without requests). If the timer is off then the device status cannot be received.
|
| Timer |
0...n |
(ms) the frequency of requests for the device status
|
| Subdevice |
1...255 |
the subdevice
|
| Value * |
0...100 |
the current property value
|
* Value - comes to the feedback channel, use it for displaying on items
