LINX - Configurator User Manual PDF
LINX - Configurator User Manual PDF
User Manual
Version 6.4
Document № 88086705
Contents
1 Introduction ................................................................................................ 15
1.1 Overview ............................................................................................................ 15
1.2 Scope................................................................................................................... 16
2 Quick-Start Guide ...................................................................................... 17
2.1 Software Installation ......................................................................................... 17
2.2 Getting Started with the LINX Configurator ................................................. 17
3 Concepts ...................................................................................................... 19
3.1 Data Points ......................................................................................................... 19
3.1.1 Overview.................................................................................................. 19
3.1.2 Timing Parameters ................................................................................... 19
3.1.3 Default Values ......................................................................................... 20
3.1.4 Persistency ............................................................................................... 20
3.1.5 Parameters ................................................................................................ 21
3.1.6 Behavior on Value Changes ..................................................................... 22
3.1.7 Custom Scaling ........................................................................................ 22
3.1.8 Protected Data Points ............................................................................... 23
3.1.9 System Registers ...................................................................................... 23
3.1.10 User Registers .......................................................................................... 25
3.1.11 Structures ................................................................................................. 25
3.1.12 Property Relations.................................................................................... 26
3.1.13 Convertible Engineering Units................................................................. 27
3.2 Math Objects ..................................................................................................... 28
3.2.1 General Properties.................................................................................... 28
3.2.2 Usage Hints .............................................................................................. 29
3.2.3 Function List ............................................................................................ 29
3.3 Connections........................................................................................................ 31
3.3.1 Local Connections ................................................................................... 31
3.3.2 Multi-Slot Connections ............................................................................ 32
3.3.3 Automatic Generation and Templates ...................................................... 33
3.3.4 Global Connections .................................................................................. 34
3.3.5 Forward Delay ......................................................................................... 35
3.4 AST Features ..................................................................................................... 35
3.4.1 Alarming .................................................................................................. 35
3.4.2 Historical Alarm Log ............................................................................... 37
3.4.3 Scheduling ............................................................................................... 37
3.4.4 Trending ................................................................................................... 39
Abbreviations
1 Introduction
1.1 Overview
The LINX Configurator is the configuration software used for the L-INX, L-GATE, L-ROC,
L-IOB, and L-DALI products. These products contain a number of components and network
technologies, such as the protocols BACnet, CEA-709, KNX, Modbus, M-Bus, MP-Bus,
SMI, EnOcean, DALI, ekey.
Data from the supported network technologies are available as data points in the automation
server. Those data points are freely configurable via the configuration software, which
provides a fast and easy way to configure a LOYTEC device using online network scans,
import/export features or device templates. Data points between different network
technologies can be connected to each other for data transfer between those network
technologies (gateway). Data points are also subject to alarming, trending and scheduling
(AST) functions of the automation server. The usage of math objects allows basic
calculations and the built-in E-mail client allows the LOYTEC device to transmit e-mails on
certain conditions. Generated alarms can be configured to send e-mails to predefined
addresses. Alarms can also be stored in a historical alarm log. Trended data collected by the
device and is available in CSV format and through a dedicated Web service.
Only the L-INX and L-IOB Controller family contains a freely programmable controller that
can operate on all data points. The controller application is developed using the provided
IEC-61131 compliant design tool. The L-ROC family also contains a freely programmable
controller, which is developed under L-STUDIO following IEC-61499. The L-DALI family
is designed for lighting applications and has a built-in constant light controller.
1.2 Scope
This document covers the LINX Configurator with version 6.4 and how it is used to configure
a LOYTEC device. The device setup itself and its operation on the Web interface is not the
scope of this manual and covered in the respective LOYTEC Device User Manual.
2 Quick-Start Guide
This chapter shows step-by-step instructions on how to set up the LINX Configurator and get
ready to configure a LOYTEC device.
System requirements:
LNS 3.1 SP8 U1, LNS 3.2 TE SP5, OpenLNS (for LNS mode),
Windows 7, Windows 8, Windows 10 or Windows Server 2003 (32 bit), Windows
Server 2008, Windows Server 2012, Windows Server 2016,
Internet Explorer 10 or higher.
The LINX Configurator can be downloaded from the LOYTEC Web site
http://www.loytec.com. When asked for the type of installation, there are two options to
choose from. Select Typical to install the required program files. Select Full to install the
LONMARK resource files along with the software. This option is useful, when the system does
not have the newest resource files.
2. When the device is online, connect to the device by clicking on the Connect to device
speed button as indicated by the red rectangle in Figure 1.
3. For detailed information on how to create data points out of the network please refer to
Section 5.3 for CEA-709 or 6.3 for BACnet.
3 Concepts
At the data point level, the specific technological restrictions are abstracted and hidden from
the user. Working with different technologies at this level involves common work-flows for
all supported technologies.
The direction of a data point is defined as the “network view” of the data flow. This means,
an input data point obtains data from the network. An output data point sends data to the
network. This is an important convention to remember as different technologies may define
other direction semantics. If a data point can both receive and send data on the network, its
direction is set to value, indicating no explicit network data flow.
Pollcycle (input, value): The value is given in seconds, which specifies that this data
point periodically polls data from the source. This is referred to as static polling.
Receive Timeout (input, value): This is a variation on the poll cycle. When receive
timeout is enabled, the data point must receive a value update within the receive timeout
period. If it does not receive a value, a technology may actively poll the source. If no
value has been received after another period, the data point is set offline and triggers a
fault alarm, if configured. Writing data from any source (network technology,
connection, logic program) the receive timeout is reset.
Poll-on-startup (input, value): If this flag is set, the data point polls the value from the
source when the system starts up. Once the value has been read, no further polls are sent
unless a poll cycle has been defined.
Minimum Send Time (output): This is the minimum time that elapses between two
consecutive updates. If updates are requested more often, they are postponed and the last
value is eventually transmitted after the minimum send time. Use this setting to limit the
update rate.
Maximum Send Time (output): This is the maximum time without sending an update.
If no updates are requested, the last value is transmitted again after the maximum send
time. Use this setting to enable a heart-beat feature.
Dynamic polling is a feature that some network technologies offer. With static polling the
pollcycle is used to permanently poll values over the network. This is required for data points
that require constant value updates a fixed pollcycle (for example to trend the data). For other
data points that do not need permanent value updates, so-called dynamic polling is activated,
as soon as the values are needed (for example displayed on the data pont Web UI or in L-
WEB). If dynamic polling is active, the data points are polled using the configured pollcycle.
When the data is no longer needed, polling stops and no longer puts a burden on the network.
The advantage is that a few data points can be refreshed at a higher rate at a time compared
to static polling, where all data points must permanently share the available network
bandwidth.
Background polling can be enabled in the project settings. With this feature enabled, all input
data points, which rely on polling depending on the underlying network technology, are
polled one-by-one in a round-robin fashion. This happens even if no pollcycle is set or
dynamic polling is activated on those data points. The frequency of the background polling
can be defined in the project settings. The default is 60 polls per minute.
3.1.4 Persistency
Data point values are by default not persistent. This means that their value is lost after a
power-on reset. There exist different strategies for initializing data points with an appropriate
value after the device has started.
For input data points, the value can be actively polled from the network when starting up.
Use the Poll-on-Startup feature for this behavior. Polling the network values has the
advantage that intermediate changes on the network are reflected. An input data point can be
made persistent, if the last received value shall be available after a power-on reset before a
poll-on-startup completes. This can be beneficial, if the remote device is temporarily offline
and the last value is considered usable.
For output data points, the value can be restored after starting up by the application. For
example, if the output data point’s value is determined by an input data point and a math
object, or the output data point is in a connection with an input, the input can poll its value
on startup. If the output data point has no specific other value source, e.g., it is a configuration
parameter set by the user, it can be made persistent.
To make a data point persistent, enable the Persistent property of the respective data point.
The persistency option is only available for the base data point classes analog, binary, multi-
state, string and user. More complex objects such as calendars, schedules, etc., have their
own data persistency rules. Persistency is also available for unlinked favorites.
For structured data points, only all or none of the structure members can be made persistent.
The configuration of the top-level data point, which represents the entire structure, serves as
a master switch. Setting the top-level data point to be persistent enables persistency for all
sub-data points. Clearing it disables persistency for all sub-data points.
3.1.5 Parameters
A data point can be qualified as a parameter data point. This is accomplished in the
Configurator software by setting a Parameter check box on the data point. Those parameter
data points are automatically persistent and will typically have a default value. Their purpose
is to store parameterization values, which can be changed from the default value at run time
and influence the behavior of the device or the logic running on the device. This way, a
number of devices can have the same basic configuration and be adapted by parameter values.
Examples are sunblind run times for control logic or descriptive strings for the L-WEB
visualization.
The qualified parameter data points are also exported via a parameter file, which contains the
entire set of current parameter values including meta-information for external tools to display
parameter data in a human-readable way. The LWEB-900 parameter view can process such
parameter data points and manage them for a large number of devices. For more information
on how to manage parameters on your devices please refer to the LWEB-900 manual [5].
When changing parameters on the device or via the LWEB-900 parameter view, they are out
of sync with their default values in the configuration. As a default it assumed that parameters
are managed by LWEB-900 and the Configurator does not download and overwrite
parameter values to the device.
The project settings can be changed to have the Configurator manage parameters (see Section
Figure 2). In this mode the Configurator provides a mechanism to resolve value conflicts and
to merge changed parameters back into the configuration. This is accomplished in the
parameter merge dialog when uploading or downloading the configuration (see Figure 2).
The user can select a resolution in the drop-down box. The arrow indicates in which direction
the parameter values shall be copied: Copy value from device to default value, write default
value to the device or NONE to leave configuration and value on device separate.
When selecting a resolution on single parameters it affects only those parameters. When
selecting a resolution on a folder it affects all data points under this folder. Click on Ignore
to skip the parameter merge process.
L-IOB parameters are not managed by LWEB-900 and the Configurator always tries to
merge L-IOB parameters that have been changed on the device. Frequent changes made to
manual/auto mode can be ignored by checking Always ignore L-IOB manual/auto mode
differences.
When the value of an output data point is updated, an update is usually sent out onto the
network. The property Send-On-Delta decides how the update is reflected on the network.
If send-on-delta is inactive, each update of the value is sent, even if the value does not change.
If send-on-delta is active, only value changes are sent. The send-on-delta property is only
valid for output data points.
For analog data points, the COV or send-on-delta takes an extra argument, which specifies
by what amount the value must change to regard it as a change for action. Both, COV and
send-on-delta for analog data points check the Analog Point COV Increment property. A
change is detected, if the value increment is bigger or equal to the specified increment. If the
property is ‘0.0’, all updates are reported, even if the value does not change. The Notify on
any COV property modifies this behavior to detecting any change, regardless of the COV
increment.
Data point usages, such as COV trend logs or math objects may specify their own COV deltas
on analog data points. These can be bigger than the data point COV itself, but never smaller.
A = k N + d,
where N is the network value, k the custom scaling factor, d the custom scaling offset, and A
the application value. When sending a value to the network, the reverse scaling is applied. If
this property is enabled, the analog values are pre-scaled from the technology to the data
point. The custom scaling is in addition to any technology-specific scaling factors and can be
applied regardless of the network technology.
System registers are read-only by default. System register can also serve as a testing setup
for the OPC XML-DA communication without a network data point configuration. The
System Time register is updated every second and may serve for testing subscriptions. The
Authentication Code register can be used to verify writing to OPC tags.
The available system registers and a short description of their function are listed below:
State Summary: This multi-state register contains one of the following values:
o OK (1): The device is in normal state. All modules are running without
problems.
o WARNING (2): Some modules on the device reported a warning. The device
may not function as expected.
o ERROR (3): Some modules on the device reported an error. The device is not
functioning as excpected.
System Time: This register is an analog data point. It supplies the system time of the
local clock in UTC as seconds since 1.1.1970. It increments each second. Example:
1302533716.
Time UTC: This register is a structured data point. It supplies the system time as UTC
broken down to year, month, day, hour, minutes and seconds.
Time Local: This register is a structured data point. It supplies the system time as local
time broken down to year, month, day, hour, minutes and seconds.
Unit System: This register shows the unit system the device is currently running on. It
can be either metric (SI) or U.S.
Unit System Set: This register can be written to. It can request a change to another unit
system. When changing it, the device needs to be rebooted to let this change become
effective. This can be done via the Command system register or any other reboot
mechanism.
CPU Load: This register is an analog data point. It displays the average system CPU
load in percent over the last minute. Example: 17 %.
Free Memory: This register is an analog data point. It displays the current amount of
free RAM memory in Bytes. Example: 20522288 Bytes.
Free Flash: This register is an analog data point. It displays the current amount of free
memory in Bytes of the Flash storage. Example: 8482688 Bytes.
Supply Voltage: This register is an analog data point. It displays the currently measured
supply voltage in volts. Example: 15.1 V. Note, that for AC powered devices the voltage
reading is VAC * sqrt(2), e.g., 24VAC reads as 34V.
System Temp: This register is an analog data point. It displays the currently measured
system temperature in degrees Celsius. Example: 39 °C.
Application Vendor, Authentication Code, and Authentication Result: These
registers can be used to implement an IP protection mechanism for application programs,
such as IEC61131 programs.
Serial Number: This register is a string data point. It displays the device’s serial number
as an ASCII string. Example: “011401-000AB001D1E4”.
MAC Address: This register is a user data point. It displays the device’s MAC address
as an array of 6 hexadecimal Bytes. Example: 000AB001D1E4.
Firmware Version: This register is a string data point. It displays the device’s firmware
version as an ASCII string. Example: “4.1.0”.
Device IP Address: This register is a string data point. It displays the device’s IP address
as an ASCII string. Example: “10.101.18.204”.
Device IP Port: This register is an analog data point. It displays device’s HTTP port as
an integer value. Example: 80.
TZ Offset: This register is an analog data point. It displays the time zone offset relative
to UTC in seconds. This means a positive value for a time zone, which lies east of
Greenwich. The offset includes daylight savings time. The local time can be derived by
adding this register to the system time register. Example: +7200 for GMT+1 (Paris,
Berlin, Vienna) including DST.
Device Status: This register is a string data point. It contains an XML document with
the device status file contents. It is not displayed on the Web UI.
Ethernet Link Mask: This register is a multistate data point. It displays the link
information of the Ethernet port. Example: “Eth 1”.
Hostname: This register is a string data point. It displays the host name, which has been
configured in the IP settings. Example: “my_linx”.
Position Longitude: This register is an analog data point. It displays the longitude part
of the device’s location in degrees. Writing to the corresponding data point Position
Longitude_Set sets the device’s longitude in degrees. Example: -16.33472.
Position Latitude: This register is an analog data point. It displays the latitude part of
the device’s location in degrees. Writing to the corresponding data point Position
Latitude_Set sets the device’s latitude in degrees. Example: 48.22056.
Position Altitude: This register is an analog data point. It displays the altitude of the
device’s location in meters above sea level. Writing to the corresponding data point
Position Altitude_Set sets the device’s altitude in meters above sea level. Example: 200
m.
Sun Azimuth, Sun Elevation: These registers represent the sun position depending on
the current day time and geographical location. The registers are updated once a minute.
Secure Mode: On models providing a firewall, this binary register enable the firewall to
restrict access to the services provided in the Secure Services register.
Secure Services: On models providing a firewall, this string register selects the services
which should be available when Secure Mode is TRUE. This registers accepts a space-
separated list of service names. If the selected services would make the device
unconfigurable, a default configuration with HTTPS and SSH enabled is selected. The
available service names are:
A register merely serves as a container for intermediate data (e.g., results of math objects,
calculation parameters). The register can have the following, basic data types:
Double: A register of base type double is represented by an analog data point. It can
hold any scalar value. No specific scaling factors apply.
Signed Integer: A register of base type signed integer is represented by a multi-state
data point. This register can hold a set of discrete states, each identified by a signed stats
ID.
Boolean: A register of base type Boolean is represented by a binary data point. This
register can hold a Boolean value.
String: A register of base type string is represented by a string data point. This register
can hold a variable-length character string in UTF-8 format.
Variant: A register of base type variant is represented by a user data point. This register
can hold any user-defined data of up to a specified length of Bytes. This length is defined
when creating the register and cannot be changed at run time.
Since a register has no network direction, it can be written and read. Therefore, it is created
as a value data point by default. It is also possible to create two data points for each register,
one for writing the register (output) and one for reading the register (input). In this case a
suffix is added to the register name to identify the respective data point. For example, the
register MyValue will have two data points generated for: MyValue_Read and
MyValue_Write.
3.1.11 Structures
Complex data belonging semantically together may be structured. The data point model
allows mapping structure types onto user-defined data points of variant type. This can be
necessary, if a network technology carries such structured data or if a user-defined register
shall provide structured data for access through a single data point. In any case, the structure
is modeled as a top-level data point and a hierarchy of sub-data points representing the
structure members.
The top-level data point is a user data point of variant data type. It contains the image of the
entire structure as a Byte array. Each structure field is then modeled as a sub-data point of
the appropriate class (e.g. analog, binary, or multi-state). A structure field may itself be a
structure going down one level in the hierarchy of sub-data points.
An example is shown in Figure 3. In this case a user register of two Bytes is bound to a
structure type mapping the two bytes on analog data points. The two sub-data points byte_0
and byte_1.
The structure types are available in a type repository with the Configurator. This repository
is divided into scopes. Within each scope a type has a unique name. When selecting a type,
the scope and the type name needs to be specified.
Favorites can also be structured. A structured favorite can be created by dragging a structured
data point into the favorites folder. As a default, the structure top is linked to the structure
top of the target data point while all sub-element are linked to their respective target sub-
elements. It is also possible to unlink the structure top and link its sub-elements to different
individual data points. When entirely unlinked, the structured favorite behaves like a
structured user register.
In some cases property values shall also be updated by other data points, e.g. a user register
or a technology data point. In this case the data point property is linked to another data point
following a given, semantic relation. This is modeled as a property relation. Property
relations appear as data point links with the respective property names underneath their
governing data point. An example is shown in Figure 4. They are marked with a link symbol
. When hovering with the mouse over the link symbol, a bubble help appears describing the
property relation.
The property relations can be accessed like regular sub-data points from the Web UI, by
L-WEB over the OPC web service or by a PLC program. For this usage, no linkage against
other data points is necessary. Property relations may, however, also be linked to other data
points, e.g. ‘feedbackValue’ in Figure 4. In this case the linked data point is used as the
related property. The user may right-click on a linked property relation and choose Go to
related data point from the context menu. For mass engineering property relation links to
other data points refer to Section 4.2.8.
value. The Configurator matches this text against its database of known engineering units. If
it can identify the unit, it is denoted as a convertible unit with a green checkmark .
Convertible units are linked to additional meta-information in the metric (SI) or U.S. unit
system. For each data point the Configurator offers unit representations in the respective unit
system. Data points will provide values in that unit system. These may be different from
values transported over an underlying network. For those technologies the Configurator
defines a fixed network unit.
Important! When changing the unit system, the device needs to be rebooted and will reset all persistent
values to their default values converted to the chosen unit system.
Automatic unit conversion in local connections is performed, if data points with
compatible convertible units are connected (e.g. ‘1000 W’ are converted to ‘1 kW’). No
custom scaling is required.
Auto-generated data points in connections are created such that they have a best-
matching unit in their target technology (e.g., the best-matching SNVT is created out of
a BACnet data point of a certain engineering unit).
For example, a data point has a fixed network unit in °C. As it is a convertible unit, the user
can define a representation for that data point in the metric (SI) system (°C) and one in the
U.S. system (°F). Depending on the selected unit system, the received value on the network
is converted either to °C or °F. All data point values on the device are processed in the
selected unit system, including the Web UI, OPC server, parameter file, global connections,
and programmable logic. For more information on how to start a project in SI or U.S. units,
please refer to Section 4.4.7.
Using the assigned variable names, immediate values, parenthesis, operators and function
names, the user can enter a formula in the usual way (infix notation). Apart from the functions
in the next Section, the short-hand operators +, -, /, *, %, AND, OR, XOR, ^, &, |,
=, !=, <, >, <=, >= can be used directly. Further, it is possible to use parenthesis to define
the precedence of the operations.
Note: As usual practice in programming languages, the comma is used to separate arguments in
expressions and the decimal point is used in decimal values. The expression sum(4,5)*2
evaluates to 18, while sum(4.5)*2 evaluates to 9.
As you enter the formula, it will be parsed and the resulting sequence of calculations will be
displayed in a list at the right of the property page. This list shows your formula in reverse
polish notation (RPN), also known as postfix notation, as used by many scientific pocket
calculators.
This behavior causes some limits in how these functions may be used. You are on the safe
side, if you use such a function only as the outermost function (infix), or as the last function
on the stack (postfix) for example:
If you have to use it as an argument to another function, it may only be the first argument;
otherwise the formula cannot be processed by the math object, which internally uses an RPN
machine, with precompiled instructions for optimal performance. Example:
add(5, avg(v1, v2, v3)) or 5 + avg(v1, v2, v3) will NOT work.
Another property of those functions is that they ignore input values, which have the invalid
value. Therefore, assuming v1=5, v2=invalid, v3=3 the calculation add(v1,v2,v3)
evaluates to 8 while v1+v2+v3 returns invalid. This can be used to purposely allow inputs
in the calculation that have no value.
To limit the number of re-calculations, the data point option Only Notify on COV should
normally be checked on all connected input data points. This avoids recalculating the formula
and writing a value to the output data point when it is already clear that the result will be the
same, because the input value did not change. The same option can also be checked for the
output data point to avoid unnecessary writes to the output data point, in case the inputs
changed but the result of the formula is still the same.
add(v1,v2) v1 + v2
sub(v1,v2) v1 - v2
mul(v1,v2) v1 * v2
div(v,d) v/d
Returns the remainder of dividing v by m, where v and m should be integer values. Fractional
mod(v,m)
values will be rounded to the nearest integer automatically
max(v1,...) Returns the maximum of all values on the value stack
min(v1,...) Returns the minimum of all values on the value stack
avg(v1,...) Returns the arithmetic mean value of all values on the stack
log(v) Returns the natural logarithm of v
log2(v) Returns the base 2 logarithm of v
log10(v) Returns the base 10 logarithm of v
exp(v) Returns the value of e (the base of natural logarithms) raised to the power of v
exp2(v) Returns the value of 2 raised to the power of v
exp10(v) Returns the value of 10 raised to the power of v
sqrt(v) Returns the non-negative square root of v
pow(v,exp) Returns the value of v raised to the power of exp
round(v) Round v to the nearest integer
floor(v) Round v down to the nearest integer
ceil(v) Round v up to the nearest integer
sum(v1,...) Returns the sum of all values on the stack
and(b1,b2) logical AND of the Boolean values b1 and b2 (b1&&b2)
or(b1,b2) logical OR of the Boolean values b1 and b2 (b1||b2)
xor(b1,b2) logical exclusive OR of the values b1 and b2 (b1^b2)
not(b) logical inverse of the Boolean value b (!b)
lt(v1,v2) returns 1 if v1 is lower than v2, else returns 0 (v1 < v2)
le(v1,v2) returns 1 if v1 is lower or equal v2, else 0 (v1 <= v2)
eq(v1,v2) returns 1 if v1 equals v2, else 0 (v1 = v2)
ge(v1,v2) returns 1 if v1 is greater or equal v2, else 0 (v1 >= v2)
gt(v1,v2) returns 1 if v1 is greater than v2, else 0 (v1 > v2)
if(b,vt,vf) returns vt if b is true, else returns vf (b ? vt : vf)
Reads all values from the stack, converts them to Boolean values and encodes them into an
encode(b1,...)
integer value, where the first value is used as the LSB and the last value as the MSB.
sin(v1) Returns the sine of v1, where v1 is given in radians
cos(v1) Returns the cosine of v1, where v1 is given in radians
tan(v1) Returns the tangent of v1, where v1 is given in radians
sinh(v1) Returns the hyperbolic sine of v1, which is defined mathematically as (exp(v1) - exp(-v1)) / 2
Returns the hyperbolic cosine of v1, which is defined mathematically as (exp(v1) + exp(-v1)) /
cosh(v1)
2
tanh(v1) Returns the hyperbolic tangent of v1, which is defined mathematically as sinh(v1) / cosh(v1)
asin(v1) Returns the arc sine of v1; that is the value whose sine is v1
acos(v1) Returns the arc cosine of v1; that is the value (in radians) whose cosine is v1
atan(v1) Returns the arc tangent of v1; that is the value (in radians) whose tangent is v1
asinh(v1) Returns the inverse hyperbolic sine of v1; that is the value whose hyperbolic sine is v1
acosh(v1) Returns the inverse hyperbolic cosine of v1; that is the value whose hyperbolic cosine is v1
atanh(v1) Returns the inverse hyperbolic tangent of v1; that is the value whose hyperbolic tangent is v1
Returns the value of the Gamma function for the argument v1. The Gamma function is defined
by Gamma(x) = integral from 0 to infinity of t^(x-1) e^-t dt. It is defined for every real number
gamma(v1) except for no positive integers. For nonnegative integral m one has Gamma(m+1) = m! and,
more generally, for all x: Gamma(x+1) = x * Gamma(x) For x < 0.5 one can use Gamma(x) *
Gamma(1-x) = PI/sin(PI*x)
abs(v1) computes the absolute value of the argument v1
Table 1: Available math functions.
3.3 Connections
3.3.1 Local Connections
With the use of connections data points can interact with each other. Connections specify
which data points exchange values with each other. Various types of connections – from
“1:n” to “m:n” connections – are supported. Data points added to a connection specify
whether they feed a value into the connection (send) or they receive a value from the
connection (receive).
The most common connection will be the 1:1 connection. This is the type of connection that
is auto-generated by the Configurator software. Other types must be created manually or by
a template in the Configurator.
In the 1:n connection the input value is distributed to all n output data points. In the m:1
connection, the most current input value is written to the output data point. When polling the
output data point in poll-through mode (maximum cache age is set on the output), the value
from the first input data point is polled. The same holds true for a m:n connection. The default
data flow of data points in a connection is a result of the data point direction. This can be
overridden by a custom setting (i.e. an output data point can be configured as an input to the
connection).
Connections can connect data points of different technologies with each other (also mixed
among the target data points). When connecting data points of different classes the exchanged
values need to be converted. The connection inherits the type of the first data point class. If
data points of a different class are added to this connection, an adaptor needs to be defined.
For example an analog value connection has a multi-state output data point. Adaptors can be
saved in a library and re-used later for similar conversions.
connection
connection
IN A In 1
IN A Slot 1 OUT X IN B In 2
IN B Slot 2 OUT Y IN C In 3
Out 1 OUT X
Out 2 OUT Y
(a) (b)
Figure 5: Multi-slot connection (a) and multi-slot with math block adaptor (b).
Some gateway applications also require a functional mapping between different data point
structures in one connection. A multi-slot connection can be used with a math block adaptor
to accomplish this task. A math block has n inputs and m outputs. The multi-slot connection
has a slot for each input and output, which can be connected to the respective data points as
depicted in Figure 5 (b). For this multi-slot connection the math block adaptor defines a fixed
layout of the slots; no more slots can be added to this connection.
In a math block adaptor with n inputs v1, v2, … , vn each output oi is calculated as a formula
depending on all inputs oi = fi(v1, v2, … , vn). Each output has two math formulae following
the same format as used in math objects (see Section 3.2):
Output value formula: This formula calculates the output value as a function of all input
values.
Output enable formula: This formula calculates an output enable (result > 0 is enable)
for the output. If the output is enabled, the output value will be written to the output. If
the output is disabled, the calculated output value is not written to the output.
In addition, each input slot can be configured whether it shall trigger the calculation or not.
Normally, any change in any input triggers the calculation of all outputs.
In principle, the Configurator supports auto-generate for all source technologies but
generation is limited to select target technologies. Depending on availability on the device
model, the following technologies can be target for auto-generation:
Registers,
The target data point is generated with opposite direction and of the same class as the source
data point. Depending on the target technology, however, certain restrictions apply on what
can be generated. Typical issues are engineering units, state maps and data point structures.
The folder structure of the source data points is replicated for the target data points.
For example, when generating matching counter parts to NVs, there are two types of NVs to
be considered: Simple NVs that hold only one value (scalar or enumeration), and structured
NVs, that consist of a number of fields. For simple NVs only one BACnet object per NV is
generated. For structured NVs, one BACnet object is generated for each structure member.
This method is called structure flattening. Some target technologies do support structures and
no flattening is applied. When generating an analog target, a data point with the best-
matching engineering unit is created. If the target allows arbitrary engineering units this will
be the same as the source engineering unit. If the target has only a limited number of
engineering units, the technology object with the best-matching unit is created. Multi-state
target data points are created with an equal number of states and compatible state IDs. For
example the CEA-709 state IDs are sorted and renumbered to start at ‘1’ in BACnet (i.e., a
‘-1’ of MOTOR_NUL in CEA-709 maps to a ‘1’ of MOTOR_NUL in BACnet). This is
necessary as the SNVT states ‘-1’ and ‘0’ cannot be represented in BACnet as a raw value,
because allowed BACnet multi-states start at 1.
The Configurator provides a preview dialog that shows, which target data points will be
created. Thus, the implicit generation rules are visible to the user. If the target technology
provides several options on what to generate, the user can change the default in this dialog.
The setting is stored in the project and will be applied again with the next generation. The
project settings also provide defaults for auto-generation. How exactly data points are created
depends on the target technology. Refer to the technology sections for more information how
data points are used in connections.
For more advanced connection tasks that involve specific adaptors auto-generate templates
must be used. An auto-generate template contains the source data point, the desired target
data point and the local connection with all appropriate adaptors. There are two types of auto-
generate templates:
Simple auto-generate template. This template contains exactly one source data point
(scalar or structured). It may contain one or more target data points, which will be
generated. This template can be applied on any selection of single source data points. If
the type of the source data point matches the one in the template, this auto-generate
template can be selected to generate the target data points. This template type can be
used to generate special target objects for certain scalar source data points using
adaptors. It can also be used to connect structure elements of the source to structure
elements of a target using a math block adaptor.
Complex auto-generate template. This template contains more than one source data
points. This type must be used, if two or more sources shall generate the targets in a
specific way. Since no single source data points can be matched in this case, the source
data points which belong together must be grouped under a folder. Math block adaptors
can be used with complex auto-generate templates.
Auto-generate templates can use configurable placeholders for data point name, data point
description, server object name, server object description. These placeholders are evaluated when
the template is applied and new data point instances are created. The available placeholders are
listed in Table 2.
Placeholder Meaning
%{name} In simple auto-generate templates this expands to the source data point name.
%{descr} In simple auto-generate templates this expands to the source data point description.
In simple auto-generate templates this expands to the native name (e.g. register name,
%{native_name} NV programmatic name, server object name) of the source data point. If no such native
name exists, the data point name is used instead.
In simple auto-generate templates this expands to the native object description (e.g.
%{native_descr} server object description) of the source data point. If no such native description exists,
the data point description is used instead.
This placeholder expands to the source data point/folder path. The path extends up until
%{path} the respective data point folder root folder. Example: The source data point is located in
‘CEA-709 Port.Datapoints.Floor1.Room202’. The path expands to ‘Floor1.Room202’.
%{folder_descr} This placeholder expands to the folder description of data point’s parent folder. Folder
descriptions are copied from source to generated folders.
Table 2: Placeholders in auto-generate templates.
The system in which the data cloud of a global connection is established is defined by an
IP-852 channel. This channel is not related to the CEA-709 technology; it is purely used to
define the set of devices exchanging data through global connections. It can, however, coexist
with an IP-852 channel for CEA-709. The configuration of the IP-852 channel is done by
adding devices to a configuration server. This is described in closer detail in Section
„Configuration Server for Managing the IP-852 Channel” of the LOYTEC Device User
Manual.
The following properties are derived from the data points in a global connection:
Receive Timeout: A data point with a receive timeout will be put into the state offline,
if it does not receive a value within the specified period of time (see Section 3.1.2). This
also applies to values received from the global connection.
Poll on startup: If a data point in the global connection has the poll on startup feature
enabled (see Section 3.1.2), an initial value update will be triggered for the global
connection.
How a global connection is created and configured in the Configurator software is described
in Section 4.5.7. Note, that the number of configurable global connections on a device is
limited per device model.
If updates are generated faster than they are forwarded because of the delay, the last update
overwrites any pending updates. No queueing is implemented for delayed updates over
connections.
Generic alarm servers provide the maximum set of alarming features and can be accessed
over L-WEB (via the Web service) or the Web UI. Data points of all network technologies
can be alarmed through generic alarm servers. Technology alarm servers can be used to
expose access to the alarms to network technologies that support it. Generic alarm servers
can be configured to report their generic alarms to technology alarm servers. For example, a
generic alarm server may report its alarms to both CEA-709 and BACnet alarm servers.
An alarm record contains the information about a specific alarm. This includes information
about the alarm time, the source of the alarm (i.e., which data point caused the alarm), an
alarm message, an alarm value, an alarm type, an alarm priority, and an alarm state. An alarm
record undergoes a number of state changes during its life-cycle. When the alarm occurs, it
is active. At this point the alarm time, alarm message, alarm value is notified using the alarm
priority. When the alarm condition subsides, the alarm becomes inactive. At this point the
clear time and the clear message is notified using the normal priority. The priority levels are
configurable on the alarm server, where 0 is the highest and 255 is the lowest priority.
Alarm transitions (to an alarm state, to the normal state) can be acknowledged by an operator.
Which of those transitions requires an acknowledgement is configurable on the alarm server.
If an active alarm is acknowledged it becomes active acknowledged. Active alarms can also
become inactive, but an acknowledgement is still required. Then they become ack-pending.
When an alarm is inactive and was acknowledged it finally disappears from the alarm
summary.
An alarm state can be of different alarm types. The alarm type specifies the class of the alarm.
The following alarm types exist:
Off-Normal Alarm: This alarm type is a generic alarm class that applies to binary and
multi-state alarm conditions. It indicates that the alarmed data point is on an off-normal
operating condition that triggered the alarm. An alarm value is supplied. In technology
alarm servers, restrictions may apply.
High/Low Limit Alarm: This alarm type is typical for analog alarm conditions. It
applies when the alarmed value is over or under the defined alarm limits. An alarm value
is supplied. In technology alarm servers, restrictions may apply.
Fault Alarm: This alarm type is indicating that the monitored data point is in a fault
state. This is different from off-normal or high/low limit alarms. The value of the data
point is within the specifications of the alarm condition but the data point itself is
considered faulty. This can stem from an unreliable value or an offline value, i.e., if the
data point is offline. No alarm value is supplied.
Alarms may be generated from a given data point value (alarm value or value range) or by
comparing a data point command value with a feedback value (feedback alarm). When
defining a feedback alarm, the alarmed data point represents the command value and has a
‘feedbackValue’ property relation (see Section 3.1.12). This property relation can be linked
to another data point, which effectively provides the feedback value.
Alarmed data points also possess other property relations. The ‘enableAlarm’ property
relation can be used to disable or enable alarm conditions when linked to a data point. The
property relations ‘highLimit’, ‘lowLimit’, ‘deadband’ can be used to modify analog alarm
conditions. The property relations ‘inAlarm’ and ‘ackPend’ are TRUE if a data point is in an
alarm state or needs acknowledgement, respectively.
When a data point is alarmed by a generic alarm server, which reports to a technology that
requires a dedicated technology data point (e.g., an alarm for a user register is reported to
BACnet), the required data point is automatically created and linked via the ‘nativeAlarm’
property relation.
Alarm server objects possess property relations that provide a counter value of active
unacknowledged, active acknowledged, and inactive unacknowledged alarms. These
property relations may be linked to other data points that can be used to process this
information.
Other devices can access the alarm information through a technology alarm server or the Web
service. These devices are alarm clients. They register with the alarm server and get notified
about changes to the alarm summary. Alarm clients can be used to display the current alarm
summary and to acknowledge alarm transitions. Depending on the underlying technology,
some restrictions may apply to the available alarm information and acknowledgement
behavior. Refer to the technology sections for more information.
The alarm log is always local and stored as a file on the device. The size of an alarm log is
configurable. The alarm log operates as a ring buffer. As soon as its size limit is reached, the
oldest alarm log records are overwritten by newer alarm transitions. The alarm log is
available on the Web UI or can be uploaded from the device as a CSV file. The CSV file can
also be used as an e-mail attachment.
3.4.3 Scheduling
Schedulers are objects that schedule values of data points on a timely basis. A scheduler
object is configured by which data points it shall schedule. This configuration is done by the
system engineer once, when the system is designed. The configuration of the times and values
that shall be scheduled is not part of that initial configuration and may be changed later. This
distinction has to be kept in mind.
A scheduler object sets its data points to predefined values at specified times. The function
of the scheduler is state-based. This means, that after a given time, the scheduler maintains
this state. It can re-transmit the scheduled values as appropriate (e.g., when rebooting). The
predefined values are called value presets. A value preset contains one or more values under
a single label (e.g., “occupied” schedules the values { 20.0, TRUE, 400 } ). Each preset can
also be configured with a display color.
Which value preset is scheduled at what time is defined by a scheduled event. The event
defines the starting time, value preset and end time in a 24-hour period. Events can be one-
time events or recurring events. A schedule typically consists of a number of recurring and
one-time events, for instance one event for the weekdays Monday through Sunday. See
Figure 6 for an example of a schedule in a given calendar week.
How scheduled events are recurring can be defined by choosing the appropriate event type:
Daily: This event occurs every day, starting at a given date and ending at a given date.
Monthly: This event occurs every month following a date range or a defined rule (e.g.
every last Friday).
Yearly: This event occurs every year following a date range or a specific day every year.
Default: This is a special event. The selected preset value will be in effect 00:00 to 24:00
hours every day if no other event occurs.
Calendar: For some tasks the regular recurrence such as on weekdays is not sufficient.
This can be implemented by defining events based on a calendar. For instance, there
may be a calendar for holidays. The calendar contains a number of calendar patterns.
Each calendar pattern describes a pattern of dates on which an event shall occur, e.g.,
Holidays.
One can define a set of scheduled events that are recurring differently. For example one event
is defined for regular workdays (Monday through Friday). Another event is defined based on
the holidays calendar pattern. This will lead to overlapping events between workday and
holiday for those weekdays, which are holidays.
The resolution of this overlap is simple: Each event is configured with a priority. Should an
overlap occur, the event with the higher priority will be in effect (e.g., Dec 25 th in Holidays
overrides the regular workday event). An example is shown in Figure 7. The detailed view
shows the two overlapping events and the preview shows the effective schedule. Note, if two
events with the same priority exist, it is not defined, which one is in effect. Therefore, always
use distinct priorities.
Priorities are numbers, but some priorities have been pre-assigned, e.g. highest, override,
normal, low. Please also refer to the technology-specific limitations described in Section 4.7
to learn about special behavior of the respective networking technology.
If no event is in effect at a given time, the schedule default becomes effective. This can be
defined to be any of the defined presets. In Figure 7 the scheduler will write out “unoccupied”
after 12:30 as no other event exists. A special schedule default is silent. With the silent default
the scheduler will be inactive, if no event is in effect. This means it will not update its
scheduled data points until the next scheduled event, not even at midnight. Thus, using the
silent default one can build an event-based scheduler.
A date range: This defines a range. Starting with a start date and ending with the end
date. No wildcards should be used.
A Week-and-Day definition: This defines dates based on a week, such as every 1st
Friday in a month, every Monday, every last Wednesday of a month.
A schedule defines at which time instants certain states of the scheduled data points are
maintained. The next-state feature allows looking up to 48 hours ahead into the future and
predicts when the next scheduled state change will occur. There are two data points involved:
the timeToNext is a counter in minutes to the next scheduled event, and the nextState data
point is the state of the next scheduled event. This information can be used by controllers for
optimum start algorithms (e.g., pre-heat a room for the scheduled occupancy state). Use the
SNVT_tod_event in CEA-709 to accomplish this task. With generic schedulers and BACnet
schedulers use the scheduler’s property relations timeToNext and nextState (see Figure 8).
When a scheduler is executing the schedule on the local device, it is called a local scheduler.
Such a scheduler is configured to schedule data points and later its daily schedules can be
modified. When accessing the daily schedules of a scheduler, which executes on a remote
device, the object is called a remote scheduler. A remote scheduler has the same interface to
the user to modify daily schedules. A remote scheduler object can be used as a user-interface
for schedulers that execute on different devices.
A generic scheduler and calendar is a universal kind of AST object that is not visible on a
control network (such as CEA-709 or BACnet). Generic schedulers/calendars are accessible
by L-WEB and Web services only. The limitations on scheduled events and calendar patterns
are listed in Table 3. For technology schedulers/calendars refer to the BACnet and CEA-709
technology sections instead (Section 3.6.4 and 3.7.3).
Scheduled events 40
Scheduled events (at weekday priority) 24
Date entries per calendar pattern 100
Calendar patterns in the calendar 25
Table 3: Limitations of generic scheduler/calendar objects
3.4.4 Trending
Trending refers to the ability to log historical values of data points over time. A trend log
object is responsible for this task. The generic trend log object provides the maximum set of
features and can be accessed by L-WEB and the Web service. It can be configured to record
historical data of any data point on the device. Log records are generated either in fixed time
intervals, on change-of-value (COV) conditions, or when a trigger is activated. The fixed
intervals can be optionally aligned to the wall time (e.g., to the top of the hour). After a reboot
the recording is resumed at the aligned intervals. Trend log objects can trend either local or
remote data points. Technology trend log objects can be used to record historical values of
the respective technology data points and expose them to network technologies that support
it. These historic logs are separate from the generic trend logs and certain restrictions of the
technology may apply.
The trend data is stored in a binary format on the device. The capacity of a given trend log is
configured. The trend log can be operated in one of two modes: In linear mode the trend file
fills up until it reaches its capacity. It then stops logging. In ring buffer mode the oldest log
records are overwritten when the capacity is reached.
Devices with SD cards also allow backups of the trend logs on external Flash storage. This
backup can be triggered by the user over the LCD display or be triggered by certain actions.
The trend data is stored in CSV format under a folder identifying the device by serial number
and the trends sub-directory, e.g. '016101-8000000DEA51/trends'. The SD card can be used
on different devices. In this case different device directories will be created. The trend backup
files can be opened directly on a PC. The backup on external storage can be enabled
individually per trend log.
A fill-level action can be activated, whenever the trend log has logged a percentage of its log
size with new log records. A fill-level condition of 70% on a trend log with 1000 items
capacity will activate the fill-level trigger every 700 logged records. This trigger can be used
to send E-Mails or backup trend data on external storage if available.
Trended data points can be logged as their actual values at given time instants or as an
aggregated value over the defined log interval. Aggregation can be calculated as minimum,
maximum, or average. Aggregation can be beneficial, if the trended value changes more
frequently than the selected log interval. Using aggregation, the log interval can be chosen to
limit the amount of logged data while preserving information of the trended value.
For technology trend log objects, certain restrictions apply as to how many data points can
be trended in one trend log and which trend modes are available. Refer to the technology
sections for more information.
3.4.5 E-mail
The e-mail function can be combined with the other AST features. The format of an e-mail
is defined through e-mail templates. An e-mail template defines the recipients, the e-mail
text, value parameters inserted into the text and triggers, which invoke the transmission of an
e-mail. An e-mail template can also specify one or more files to be sent along as an
attachment.
The e-mail text content can contain text and configurable placeholders. The placeholders
expand to their content when the e-mail is transmitted. Placeholders can also be used in other
text fields, such the Subject field. The placeholders available for e-mail templates are listed
in Table 4.
Placeholder Meaning
This placeholder expands to the content of a data point variable defined in the e-mail
%{vn} template. The n refers to the n-th data point variable in the list. The data point
variable list specifies this index.
%{vn.name} This placeholder expands to the name of the data point variable.
%{vn.descr} This placeholder expands to the description of the data point variable.
If the data point variable is an alarm, this placeholder expands to the source name of
%{vn.src_name}
the alarmed data point, for which a new alarm is reported.
If the data point variable is an alarm, this placeholder expands to the source path of
%{vn.src_path}
the alarmed data point, for which a new alarm is reported.
If the data point variable is an alarm, this placeholder expands to the message of the
reported alarm. For a to-alarm transition it contains the alarm message, for a to-
%{vn. al_descr}
normal transition it contains the clear message, for a to-fault transition it contains the
fault message.
If the data point variable is an alarm, this placeholder expands to the alarm type of
%{vn. al_type}
the reported alarm.
If the data point variable is an alarm, this placeholder expands to the state of the
%{vn. al_state}
reported alarm.
If the data point variable is an alarm, this placeholder expands to the alarm time of
%{vn. al_tm}
the reported alarm.
If the data point variable is an alarm, this placeholder expands to the clear time of the
%{vn. cl_tm}
reported alarm.
If the data point variable is an alarm, this placeholder expands to the acknowledge
%{vn. ack_tm}
time of the reported alarm.
If the data point variable is an alarm, this placeholder expands to the acknowledge
%{vn. ack_src} source text of the reported alarm. If the alarm has not been acknowledge, this is
empty.
If the data point variable is an alarm, this placeholder expands to the value which
%{vn. al_val}
triggered the alarm (alarm value).
%{mailid} This placeholder expands to the mail ID used for the transmitted message. This mail
ID is different for each message.
%{timestamp} This placeholder expands to the mail timestamp seen in the transmitted message.
%{last_timestamp} This placeholder expands to the mail timestamp of the previous transmitted message.
Table 4: Placeholders in e-mail templates.
The amount of generated e-mails can be limited using a rate limit algorithm. The transmission
of e-mails can be disabled altogether by using a special data point. That data point can be
scheduled or driven over the network.
If an e-mail cannot be sent (e.g. the mail server is not reachable), the mail delivery is retried
up to 24 times every 30 minutes.
The following sampling periods can be defined, which allow for a certain sampling tolerance
interval if the device is not online at the sampling time:
Value every x minutes aligned to full hour (x = 1, 2, 5, 10, 15, 20, 30 min), 0 or 1 samples
ago,
Daily value at HH:MM:SS of the day, 0..60 samples ago (tolerance 5 hours),
Monthly value at HH:MM:SS on day of month (1..31, last), 0..24 samples ago (tolerance
6 days),
Yearly value at HH:MM:SS on DD/MM of the year, 0..5 samples ago (tolerance 10
weeks).
For calculating the difference between the current value and any historic value, the filter
definition can be configured in a delta mode. This is a shortcut to creating a math object
subtracting the historic filter data point value from the current value of the underlying data
point or the value of another filter item. The example shows two results: Filter item ‘2’ yields
the consumption to-the-hour of the current day (subtract value at midnight from current
value). Filter item ‘3’ yields yesterday’s consumption (subtract the value of midnight
yesterday from midnight today). The resulting values are available in data points, which can
be visualized or trended.
The historic filters definitions are managed by historic filter resources. These are templates
and stored in the project resources. They can be applied to data points. When editing an
historic filter template, all existing historic filter relations are updated accordingly. For more
information on how to configure historic filters in the Configurator please refer to Section
4.12.
3.5.1.1 Name
The name property is available for all I/Os. It is the user defined name of the I/O (e.g.:
‘Temperature1’).
3.5.1.2 HardwareType
The hardware type property is available for all I/Os. The following hardware types are
available (dependent on the L-IOB model):
This hardware type property can not be configured of course. Refer to the Section
“Specifications” of the respective product’s User Manual for a detailed specification of the
different I/O hardware types.
3.5.1.3 SignalType
The signal type property is available for I/Os of hardware type “IN Analog/Digital”. The
following signal types can be configured:
Resistance: measures resistance of about 1 kΩ to 100 kΩ. A value bigger than 500 kΩ is
detected as a disconnected sensor (except if NoValCorr flag is set, see Section 3.5.1.14).
Voltage 2-10V: measures voltage from 2 to 10 V. A value smaller than 1.75 V is detected
as a disconnected sensor (except if NoValCorr flag is set, see Section 3.5.1.14).
Current 4-20mA ext. Shunt: measures current from 4 to 20 mA. A value smaller than
3.5 mA is detected as a disconnected sensor (except if NoValCorr flag is set, see Section
3.5.1.14). An external shunt of 249 Ω must be used for correct measurement.
Current 4-20mA int. Shunt: measures current from 4 to 20 mA. A value smaller than
3.5 mA is detected as a disconnected sensor (except if NoValCorr flag is set, see Section
3.5.1.14). No external shunt is required. This setting is only available on some universal
inputs which have an internal shunt, see Section “Specifications” of the respective
product’s User Manual. Observe that changing the signal type to this setting may result
in changing the setting on other universal inputs too. In this case, a Configurator message
will inform the user of the changes.
3.5.1.4 Interpretation
The interpretation property is available for all I/Os. Depending on the hardware type and
signal type, the following interpretations can be configured:
CustomNTC: This interpretation is only available for universal inputs (hardware type
“IN Analog/Digital”) with signal type “Resistance”. It is used for connecting a custom
NTC temperature sensor to the input. The parameters of the NTC can be setup as
described in Section 3.5.1.25.
PT1000: This interpretation is only available for universal inputs (hardware type “IN
Analog/Digital”) with signal type “Resistance”. It is used for connecting a PT1000
temperature sensor to the input.
NTC10K: This interpretation is only available for universal inputs (hardware type “IN
Analog/Digital”) with signal type “Resistance”. It is used for connecting an NTC10K
temperature sensor to the input.
NTC1K8: This interpretation is only available for universal inputs (hardware type “IN
Analog/Digital”) with signal type “Resistance”. It is used for connecting an NTC1K8
temperature sensor to the input.
Ni1000: This interpretation is only available for universal inputs (hardware type “IN
Analog/Digital”) with signal type “Resistance”. It is used for connecting an Ni1000
temperature sensor to the input.
Linear: This interpretation is only available for universal inputs (hardware type “IN
Analog/Digital”). It is used to perform a linear transformation from a physical input value
(resistance, voltage, or current, see Section 3.5.1.3) to the actual value, the sensor is
supposed to measure (e.g. temperature, see Section 3.5.1.5). The input range is specified
by the signal type:
o Resistance: 0 … 10 kΩ
o Voltage 0-10V: 0 … 10 V
o Voltage 2-10V: 2 … 10 V
The output range is specified by MinValue and MaxValue, see Section 3.5.1.21. In case
of signal type “Voltage 2-10V” e.g. a measured value of 2 V would be transformed into
MinValue and a measured value of 10 V would be transformed into MaxValue.
Frequency: This interpretation is available for all inputs. It is used to measure the
frequency of the digital input resp. universal input in digital mode. The period used for
measurement is specified by the MinSendTime parameter, see Section 3.5.1.23.
Translation Table: This interpretation is only available for universal inputs (hardware
type “IN Analog/Digital”). It is used to perform a transformation from a physical input
value (resistance, voltage, or current, see Section 3.5.1.3) to the actual value, the sensor
is supposed to measure (e.g. temperature, see Section 3.5.1.5) using a transformation
table. The table can be selected with TransTable, see Section 3.5.1.24. The tables can be
setup for each L-IOB device as explained at the end of Section 4.15.4.
Frequency Table: This interpretation is available for all inputs. It is used to perform a
transformation from a frequency value (measured as described above) to the actual value,
the sensor is supposed to measure (e.g. velocity, see Section 3.5.1.5) using a
transformation table. The table can be selected with TransTable, see Section 3.5.1.24. The
tables can be setup for each L-IOB device as explained at the end of Section 4.15.4.
Physical Unit Count: This interpretation is available for all inputs. It is used to count in
a certain physical unit. The unit is setup with DataType and SIUnit_OnText, see Sections
3.5.1.5 and 3.5.1.16. The increment for each pulse is setup using the Resolution property,
see Section 3.5.1.17.
Digital: This interpretation is available for all I/Os. In case of an analog output, the off
and on output values are specified with OffValue and OnValue, see Section 3.5.1.27.
Pulse Count: This interpretation is available for all inputs. It is used to count pulses of
the digital input or universal input in digital mode. It is also used for connecting the code
signal of STId card readers, see Section 3.5.2. Like in the “Physical Unit Count”
interpretation, a unit and an increment can be setup for calculating a value of a certain
physical unit. However, in case of the “Pulse Count” interpretation, this calculation is
only used for display on the L-IOB LCD UI. The data point remains a 32-bit counter.
Occupancy: This interpretation is available for all inputs. See Section 3.5.1.26 for details.
Clock: This interpretation is available for all interrupt-capable inputs. It is used for
connecting the clock signal of STId card readers, see Section 3.5.2.
Card Data: This interpretation is available for all inputs. It is used for connecting the
data signal of STId card readers, see Section 3.5.2.
Analog: This interpretation is only available for analog outputs (hardware type “OUT
Analog”). It is used to output a voltage between 0 and 12 V. In case of using data type
“Percentage” (see Section 3.5.1.5), the output value (in percent) is scaled using the
MinValue and MaxValue properties (see Section 3.5.1.21). An output value of 50%
would e.g. translate into an actual voltage of just in the middle between MinValue and
MaxValue, an output value of 100% would translate into a voltage of MaxValue. Note
that an output value of 0% is still always translated into 0V. As soon as the output value
is slightly raised above 0% however, the voltage jumps to MinValue.
PWM: This interpretation is available for all outputs. It is used to generate a pulse width
modulated output signal. The period is setup with PWMPeriod, see Section 3.5.1.28. In
case of an analog output, the off and on output values are specified with OffValue and
OnValue, see Section 3.5.1.27. The output value (in percent) is scaled using the MinValue
and MaxValue properties (see Section 3.5.1.21). An output value of 50% would e.g.
translate into an actual pulse width of just in the middle between MinValue and
MaxValue, an output value of 100% would translate into a pulse width of MaxValue.
Note that an output value of 0% is still always translated into zero pulse width (always
off). As soon as the output value is slightly raised above 0% however, the pulse width
jumps to MinValue. This scaling is typically used to correctly control slow actuators like
heating valves. If a valve e.g. requires a pre-heating time of 1 min, using a PWM period
of 10 min, the MinValue can be set to 10% to compensate the pre-heating time. For further
information on optimal control of your actuator in PWM mode, please refer to the
corresponding data sheet. When the output value changes during a PWM period, the new
value will be applied in the current period if possible. If the value decreases, the physical
output will be switched off earlier, or immediately, if the newly defined point in time has
already elapsed. If the value increases, the physical output will be switched off later, if it
was still switched on when the value changes. Otherwise, the new value will be applied
starting with the next period. When a PWM output is in manual operating mode (see
Section 3.5.1.9), a new period is started immediately whenever the manual value is
changed.
Fading: This interpretation is available for all analog outputs. It is equal to the “Analog”
interpretation except for the behavior on a value change. The output is not immediately
set to the new value but instead a slow fading from the current value to the new value is
performed. The transition time used for fading from the current value to the new value
(fading time) is setup in the property DeadTime, see Section 3.5.1.6. Since this time is
constant, the transition speed depends on the difference between current and new value.
Ramping: This interpretation is available for all analog outputs. It is equal to the “Fading”
interpretation except that the DeadTime property (see Section 3.5.1.6) specifies the time
it takes to ramp from the minimum value to the maximum value (ramping time). This
way, the transition speed between current and new value is always equal, independent of
the difference between the two values.
3.5.1.5 DataType
The data type property is available for all inputs with interpretation “Linear”, “Translation
Table”, “Frequency Table”, “Physical Unit Count”, “Digital”, “Occupancy”, and “Switch
Mode”, as well as for outputs with interpretation “Digital”, “Analog”, “Fading”, or
“Ramping”. It specifies the physical quantity of the I/O. For outputs with interpretation
“Digital”, the data type can be chosen between “Switch” and “Duration”. In case of
“Duration”, the output has the following characteristics:
If a positive output value is written, it is interpreted as a period (in [ms]) in which the
output shall be switched on. After that period, the output is automatically switched off
again. The feedback value of the output is initially set to the given period and stays there
until the output is switched off. After that, the feedback value is set to 0.
DataType “Switch”:
DataType “Duration”:
The interlocked mechanism can be used e.g. for sunblind motors where it must be ensured
that the up and down motors are never active at the same time.
Disabled: The physical input is disabled and the data point is set to DefaultValue. This
can be used to disable unused inputs.
Auto: The input measures the value from the connected sensor.
Override: The physical input is disabled and the data point is set to OverrideValue.
Manual: The physical input is disabled and the data point is set by the user on the L-IOB
LCD UI. This can be used to simulate input values for the logic application.
The DefaultValue is also used for inputs, when no sensor value has yet been read from the
physical input or a sensor error is detected. For outputs, the OperatingMode property has
the following meaning:
Disabled: The output value set by the logic application is ignored and the physical output
(as well as the feedback value) is set to DefaultValue.
Auto: The physical output (and feedback value) is set as requested by the logic
application.
Override: The output value set by the logic application is ignored and the physical output
(as well as the feedback value) is set to OverrideValue. This can be used e.g. for
providing a constant supply voltage to a sensor.
Manual: The output value set by the logic application is ignored and the physical output
(as well as the feedback value) is set by the user on the L-IOB LCD UI. This can be used
to test actuators.
a power cycle or when the L-IOB device loses connection to the L-IOB host. If it is set, the
output is set to the last stored value in the mentioned scenarios. If it is cleared, the output is
set to the DefaultValue (see Section 3.5.1.9). Since the output values are only stored in the
L-IOB device approx. every 20 minutes, it is possible that even in the first case, the output
value temporarily changes.
Values below the signal range (below 0V, 2V, or 4mA) are not converted. The Usqrt or Isqrt
value is then used instead of the U or I value for further calculation (linear transformation or
translation table). The square root flag can be used e.g. to easily calculate a flow value instead
of a differential pressure.
values, the USUnit_OffText property specifies the unit in US mode, in case of digital values,
it specifies the OFF text (shown when the digital I/O is inactive). Using the Configurator
(Project Settings), the user can choose between SI and US units.
3.5.1.17 Resolution
The resolution property is available for all I/Os with an analog data type. It specifies the
resolution of the value display in the L-IOB LCD UI as well as the step width for the L-IOB
jog dial when manually setting an analog value or property of that I/O. For the interpretations
“Physical Unit Count” and “Pulse Count”, it also specifies the increment for each pulse, see
Section 3.5.1.4.
3.5.1.20 Offset
The offset property is available for inputs with an analog data type. It is added at the end of
the calculation to the (already processed) value. This way, e.g. temperature sensors can be
calibrated in each room without changing the common application. Observe that in the LCD
UI, the resulting input value will be displayed next to the offset value to simplify calibration.
in time. If COV is set to 0, every input value change generates an update of the attached data
point.
Observe that the MaxSendTime property is available for all I/Os (analog and digital) to act
as a heartbeat function. For outputs, it is applied both on the output value (heartbeat to
external L-IOB device) and feedback value (heartbeat from L-IOB device or local I/O).
Whenever an update is sent from an I/O because of a max send time, the connected data point
(input or feedback value) is updated too, even if there is no value change. In cases where this
behavior is not desired, the “Analog Point COV Increment” or “Only notify on COV”
property of the corresponding host data point must be set. See Section 4.2 for where these
data point settings can be made.
3.5.1.23 MinSendTime
The minimum send time property is available for all I/Os. It specifies the minimum time that
has to pass before a new update of an input or output feedback value is generated. If
MinSendTime is set to 0, all changes of the inputs or output feedbacks immediately generate
updates. For inputs with interpretation “Frequency” or “Frequency Table” (see Section
3.5.1.4), the MinSendTime property also specifies the period used for frequency
measurement.
3.5.1.24 TransTable
The translation table property is available for all inputs with interpretation “Translation
Table” or “Frequency Table” (see Section 3.5.1.4). It specifies the translation table which
shall be used for the translation. The configuration of translation tables is explained at the
end of Section 4.15.4.
T = B * (Tn + 273.16 degC) / (B + ln(R / Rn) * (Tn + 273.16 degC)) – 273.16 degC.
T is the calculated temperature in degree Celsius and R is the measured resistance of the NTC
temperature sensor.
In interpretation “Occupancy”, the occupied state is detected using a sensor which becomes
active (e.g. closes a contact) or creates pulses whenever the room is occupied. These states
are converted to an occupancy value in the following way:
When the occupied state (or a pulse) is detected, the value changes to OCCUPIED and
stays there for at least the HoldTime.
As long as the sensor stays in the occupied state or whenever new pulses are detected
during the HoldTime, the timer for the HoldTime is started again.
When the sensor stays in the unoccupied state until the HoldTime exceeds, the state goes
back to UNOCCUPIED.
From this moment on, all pulses from the sensor are ignored for as long as the
DebounceTime lasts. This is useful e.g. when light is switched off due to detecting the
UNOCCUPIED state which leads to new pulses of the sensor and in turn leads to
switching on the light again. To break this loop, the debounce time is used.
3.5.1.28 PWMPeriod
The PWM period property specifies the period (in seconds) for outputs with Interpretation
“PWM” (Pulse Width Modulation), see Section 3.5.1.4.
3.5.1.29 NominalPower
The nominal power property is available for all outputs. It specifies the nominal resp. average
expected power consumption of the device or appliance (e.g. lamp) connected to the output.
For digital outputs it specifies the average power when the output is activated (e.g. relay
closed), for analog outputs it specifies the average power when the output is set to 10 V. The
nominal power property is used to calculate the energy count data point of the output.
GroupNumber: must be equal for all three signals of one card reader.
Invert: checked if signal is low active, check data sheet of card reader.
In its live value, this L-IOB input will represent the number of codes read from the card
reader.
GroupNumber: must be equal for all three signals of one card reader.
HoldTime: specifies the time, a new code remains in the L-IOB data point. After this
time, the data point is set back to “0xBF …”, which means “not available”. If the
HoldTime is set to 0, the last read value remains until a new value is read.
In its live value, this L-IOB input will represent the read code in a 20-byte array (40 decimal
digits).
Interpretation: “Clock”.
GroupNumber: must be equal for all three signals of one card reader.
Invert: checked if signal is low active, check data sheet of card reader.
The live value of that L-IOB input will not deliver any useful data.
If a LOYTEC device is extended by a LIOB-45x/55x module over the LIOB-IP bus, the
common I/O data points for the LIOB-45x/55x module are preceded with ‘L2_1’, e.g.
‘L2_1_ProductCode’. The following common I/O data points exist for a connected LIOB-
45x/55x device:
CfgExists: flag is set if configuration for this device exists (always set).
FMWTimestamp: firmware build time stamp (date and time) of this device.
Input: current value of the input as measured and interpreted by the L-IOB device, if the
operating mode is set to “Auto”. This data point will go out-of-service, if the sensor is
detected disconnected. If the operating mode is set to a mode different than “Auto”, the
input value will be set to the corresponding manual, override, or default value, see Section
3.5.1.9.
IOStatus: current status of input. This data point will go from “OK” to “Disconnected”,
if the sensor is disconnected.
PulseTime: time between the last two pulses for signal interpretation “Pulse Count” or
“Physical Unit Count” (see Section 3.5.1.4). This can be used to quickly detect a change
of the derivative of the physical value, e.g. a change of the electric power if the measured
physical value is electric energy. Note that the PulseTime data point must be activated
via the PulseTime flag, see Section 3.5.1.12.
PulseCountInit: when this data point is written, the pulse count is reset to the written
value. This applies to inputs with Interpretation “Pulse Count” or “Physical Unit Count”,
see Section 3.5.1.4.
Feedback: the feedback data point will always be set to the current physical value of the
output. See Section 3.5.1.9 for details.
IOStatus: current status of output. This data point always has the value “OK”.
SwitchCycles: Number of switching cycles of the digital output. This is useful for
estimating the expected remaining life time of a relay. Observe that this data point is never
reset, not even by a reset to factory defaults.
RunHoursInit: when this data point is written, the RunHours data point is reset to the
written value.
EnergyCntInit: when this data point is written, the EnergyCount data point is reset to
the written value.
Universal Inputs (UI): measure voltage between 0V and 10V. The interpretation is
‘Linear’ with MinValue 0V and MaxValue 10V.
Pressure Sensors (PRESS): measure pressure between 0Pa and 500Pa (Pascal). The
interpretation is ‘Linear’ with MinValue 0Pa and MaxValue 500Pa.
Analog Outputs (AO): deliver a voltage between 0V and 10V according to the given
percentage level. The interpretation is ‘Analog’ with MinValue 0V and MaxValue 10V.
Digital Outputs (DO): relays or triacs close when the given value goes active and open
when the value goes inactive. The interpretation is ‘Digital’.
LOYTEC devices can have one physical FT port and one IP-852 port, which is accessible
over Ethernet. On a device model with the RNI option, the automation server node is
internally connected either to the FT port or to the IP-852 port. Which one is used can be
configured in the CEA-709 port configuration of the Web interface. The schematic is shown
in Figure 10 (a). If configured for the FT channel, the device provides an RNI for remote
access to the FT channel. The RNI can be used to commission nodes and trouble-shoot
communications on the FT channel.
A device model with the CEA-709 router connects the FT port and the IP-852 port. On such
a device the automation server node is always internally connected to the FT port. The
schematic is shown in Figure 10 (b).
(a) (b)
Figure 10: (a) LonMark node on a device with RNI, (b) LonMark node and router on a device with
router option.
If the automation server shall only expose network variables from the local FT channel and
there is no IP-852 backbone, then the router is not needed. In this case, the user needs to
commission only the device’s server node. To attach the FT channel to an IP-852 backbone,
the CEA-709 router in the device needs to be commissioned. Refer to the LOYTEC Device
User Manual [1] for more information on the built-in router and configuration server.
The typical procedure in configuring the device consists of the following steps:
1. Select the data points of the network to be used on the device (e.g., select the NVs in the
CEA-709 network nodes).
3. Select those data points on the device, which shall be exposed as OPC tags or as PLC
variables.
The CEA-709 NVs on the device can be created in three different ways:
Static NV: For each selected NV on the network there is a static NV created on the
device. This NV can be bound to the NV on the network. Note that adding static NVs to
the device results in a change to the default XIF file. The device is assigned a new “model
number” to reflect this change (see Section 3.6.3). Static NVs are the way to use NVs in
non-LNS systems, where bindings are used for the NVs instead of polling.
Dynamic NV: For each selected NV on the network there is a dynamic NV created on
the device. Compared to static NVs, dynamic NVs do not change the XIF interface of
the device. The dynamic NVs are created by the network management tool. Currently,
only LNS-based tools can manage dynamic NVs. As for static NVs, with dynamic NVs
it is possible to use bindings instead of polling.
External NV: The selected NVs on the network are treated as external NVs to the device.
The device doesn’t create any NVs on the device, but instead uses polling to read from
those NVs and explicit updates to write to the NVs. Therefore, no bindings are necessary
for external NVs. For input data points using external NVs however, a poll cycle must
be configured. If not configured explicitly, a default poll cycle of 60 sec. is chosen. The
default poll cycle can be changed in the project settings menu. Note, that the receive
timeout option cannot be used with external NVs.
Based on the NV the data point is derived from, the following kinds of data points are created:
Simple NVs that hold only one scalar value, e.g., SNVT_amp: Those kinds on NVs are
represented as analog data points. The data points holds the current value, NV scaling
factors are applied.
Simple NVs based on an enumeration, e.g., SNVT_date_day: Enumeration types result
in multi-state data points. They represent the state of the NV.
Structured NVs that consists of a number of fields, e.g., SNVT_switch: All structured
NVs are represented as user point. That is, the data point is structured similar to the NV
it is based on. Beneath the user data point, the individual structure fields are presented
as “sub-data points”.
For more information on the different types of network variables and their implications please
refer to the application note in Section 18.2. For CPs the allocation type “File” is used.
Each time the static interface of the device changes (i.e., static NVs are added, deleted, or
modified), the model number is changed. The model number is the last byte of the program
ID. Thus, a change in the static interface results in a change of the program ID and a new
device template needs to be created in the network management tool. A new device template
usually means that the device has to be deleted and added again in the database. All bindings
and dynamic NVs have to be created again for the new device.
When the Configurator software is connected via LNS, it supports the process of changing
the device template for the new static interface. It automatically upgrades the device template
of the LOYTEC device in the LNS database and restores the previous bindings and dynamic
NVs. If the LOYTEC device is not configured with an LNS-based tool, this support is not
available. The new static interface is only available in a new XIF file or by uploading the
new device template into the database. For more information on the static interface and
device templates please refer to the application note in Section 18.2.
Important! It is not recommended to mix manually created, dynamic NVs outside the virtual function
block and static NVs. In this case, the Configurator is not able to restore all manually
created dynamic NVs.
The Configurator supports model number ranges for different projects. By assigning a model
number range to a configuration, the Configurator can draw a new model number from within
the specified range. This feature is useful, if different device classes shall be deployed and
the model numbers need to be coordinated between installers. In this case, the installers can
agree on ranges they are free to use. The model number range can be set on the data points
tab as shown in Figure 11.
Priorities of exception days in a CEA-709 scheduler range from 0 (the highest) to 126 (the
lowest). The value 127 is reserved as a default for weekdays.
Further, the implementation as LONMARK standard objects requires the use of configuration
properties. If the number of CEA-709 schedulers or their capacities for daily schedules and
value presets is changed, the resource and static interface of the CEA-709 port changes. The
resources reserved for LONMARK calendar and scheduler objects can be changed in the
project settings (see Section 5.1.3). When downloading a project, the software verifies if
sufficient resources have been configured. If it detects a problem, the user is notified to
update the project settings. The Auto-Set feature automatically selects the right amount of
resources. The limitations are summarized in Table 5.
Dynamic polling has no effect on static or dynamic input NVs. These NVs are supposed to
have bindings and rely on update events. If static polling is configured via the pollcycle, no
change of the pollcycle is made at run-time.
CEA-709 can also be a technology target for auto-generation (see Section 3.3.3). In this case
static NVs with SNVTs are created only. If the source is an input, an NVO will be generated,
otherwise an NVI. If the source data point is analog, the SNVT is chosen with the best-
matching engineering unit. In many cases there exist SNVTs in fixed-point and floating point
versions. The default can be edited in the CEA-709 project settings. If the source is a multi-
state data point, a SNVT_count is generated and the source state map is used. If the source is
a binary data point, a SNVT_switch is created. In the auto-generate preview the user can
review and change the desired SNVTs individually before generating the data points.
BACnet server objects (SO): These BACnet objects configured by the Configurator
software to be allocated locally on the device. These objects can be accessed by the
BACnet building control system or operating workstations. They support COV
subscriptions to deliver value changes in an event-driven way. Local server objects can
be created as AI, AO, AV, BI, BO, BV, MI, MO, MV, Accumulator, Pulse Converter,
Loop, Large Analog Value, Integer Value, Positive Integer Value, Character String
Value, Octet String Value objects.
BACnet client mappings (CM): For certain applications, it is necessary that the device
acts as a BACnet client. This functionality can be configured by activating a client
mapping. Client mappings can be of the type Read, Write or Value. The read client
mapping reads out data from a server object, the write client mapping writes values to a
server object, and the value client mapping does both. When reading values a read mode
can be specified: Poll, COV, COV unsol, or Auto. This specifies how the BACnet client
accesses other BACnet objects on the BACnet network. The Auto mode determines the
best way (poll or COV) to talk with other server objects. Poll is used for objects that
need to read data from other BACnet objects in a periodic manner. COV is used to
subscribe for COV at other BACnet objects in order to get updates in an event-driven
fashion. The COV unsol mode lets the client mapping listen for unsolicited COV
broadcasts. In this mode, it does neither subscribe nor poll the object. The value client
mapping refers to a combined read and write client mapping. When writing a value to
this client mapping, the value is written to the remote BACnet object. As soon as the
Present_Value of the remote BACnet object is updated, the value is transferred back
using the selected read mode.
The direction of BACnet server objects deserves a closer look. The direction specified for
data points in the Configurator software always refers to the network view of the
communication. The definition of input and output objects in BACnet, however, refers to the
process view, which is opposite to the network. Therefore, a BACnet analog input (AI) object
is modeled as an analog output data point. The direction of client mappings naturally refers
to the network communication. Therefore, a write client mapping is represented as an analog
output data point.
In BACnet commandable objects can be written with values at a certain priority. The value
with the highest priority is in effect. When revoking a written value, the NULL value is
written. This takes back the value. When all written values are withdrawn, the
Relinquish_Default value is in effect.
For BACnet server objects the write priority defines which priority is written to the
commandable server object. It is possible to create additional priority write data points, which
can be configured to write at other priority levels. This may be necessary, if two parts of an
application are required to write with two different priorities. To know, which priority slots
are used in a commandable object, additional priority read data points can be added. They
reflect the value on a given priority slot.
The default value feature of a data point is mapped to the Relinquish_Default property for
commandable objects. For BACnet objects, which are not commandable, the Present_Value
is initialized with the specified default value.
Analog BACnet objects have no fixed network unit. Depending on the chosen unit system,
the analog BACnet object will be created with the specified metric (SI) or U.S. unit in the
Engineering_Unit property. This means that the BACnet server object changes its
representation on the BACnet network (i.e., engineering unit and value), when the unit
system is changed on the device.
Alarm servers in the BACnet technology are mapped to BACnet Notification Class (NC)
objects. Each alarm server is mapped to one NC. The notification class number can be
configured in the object instance number property of the alarm server object.
Remote alarms in the BACnet technology refer to a remote NC object. When the device starts
up, the remote alarm object reads out the current alarm state of the remote NC and reporting
objects. To get notified about alarm transitions during run-time, the device registers in the
Recipient_List of the remote NC object.
Some BACnet devices do not send a usable text in their alarm notification messages. For
those devices the alarm client provides the option Ignore alarm message text. If this option
is enabled, the alarm client ignores the message text of an alarm notification and reads the
EventMessageText (or Description) property of the alarmed object instead.
The BACnet schedule object allows only objects of one selected data type to be scheduled.
Therefore, schedulers on BACnet can only schedule one class of data points (e.g., only one
group of analog data points). As a consequence, the value preset in BACnet always has only
one element. The name of the value preset is not stored in BACnet. It is not accessible over
the BACnet network, either. Therefore, a default name is created, such as ‘22 °C’ for an
analog value. An example of two scheduled BACnet objects is shown in Figure 13. With the
extended BACnet features enabled in the project settings, a preset label can be assigned to a
specific scheduled value. For example the value ’16 °C’ can be assigned ‘night’. Click in the
column header and type the desired text.
Priorities of exception days in a BACnet scheduler range from 1 (the highest) to 16 (the
lowest). Weekdays in BACnet have no priority.
Changing the number of calendar patterns in a BACnet calendar can only be done in the
BACnet project settings (see Section 6.1.1) and not during run-time. The individual calendar
pattern entries in the calendar patterns can be changed at run-time. Therefore, it is advisable
to reserve a suitable number of calendar patterns in a BACnet calendar and leave them empty
if not needed immediately. The limitations of scheduled events and calendar patterns are
summarized in Table 6.
Scheduled events 40
Scheduled events (at weekday priority) 24
Date entries per calendar pattern 40
Calendar patterns in the calendar (configured in project settings) 10/25
Table 6: Limitations of BACnet scheduler/calendar objects
In BACnet trend logs, only one data point can be trended per trend log object. The trended
data point can be either a local BACnet server object or a remote BACnet object accessed
through a client mapping, showing the referenced property for trending to the OWS. Data
points of other technologies and the min/max/avg algorithms can be trended as generic data
points without having a BACnet property reference.
BACnet trend logs support interval, COV and trigger-mode logs, aligned intervals are
available in interval mode. The setting linear and ring-buffer logging is mapped to the
Stop_When_Full property of the underlying BACnet trend log object. This setting in the
Configurator software is a default and can be overridden by writing to the Stop_When_Full
property by the OWS. The trend log object adheres to BACnet revision 12.
If an enable data point is configured by the Configurator software, the Log_Enable property
is written with the value of that data point. If no enable data point is configured, the
Log_Enable is TRUE as a default and can be modified over the network.
The fill-level action is mapped to generating a buffer event notification in the BACnet trend
log object. The fill-level trigger can still be used for e-mails even if no notification class is
configured in the BACnet trend log object. The fill-level percentage maps to the
Notification_Threshold property. The percentage setting in the Configurator software is a
default and can be changed by the OWS over the network.
The Notify_Type and Notification_Class BACnet properties are usually written by the OWS.
If they shall be defined by the data point configuration, configure the Notify Type and
Notification Class data point properties on the trend log object to non-default values. When
doing so, the OWS can no longer change them permanently.
The BACnet technology also supports remote trend logs. A remote trend log is basically a
BACnet trend log client, which accesses trend data on another device. The remote trend can
load the trend data from the remote device and supply it to L-WEB or the trend CSV files.
If no static polling is needed at all, the pollcycle setting can be left at zero in the client
mapping. In this case, only a COV subscription is made, if the device supports COV. If COV
is not supported, polling is only started, as soon as the values are required. This is especially
important on MS/TP channels with devices, that do not support COV.
BACnet data points can be auto-generated from other data point sources (see Section 3.3.3).
Only BACnet server objects can be generated and the connected value is reflected in the
Present_Value property. Which type of BACnet object is created depends on the type of the
source data point or of the source structure member. For analog sources, analog objects are
created. The best-matching BACnet engineering unit is chosen. Other properties of analog
objects are copied from the source data point, including min and max present value. Multi-
state objects are created for source enumeration types. Which state IDs exist is documented
in the BACnet multi-state texts array. This information is copied from the source and made
compatible with BACnet restrictions by renumbering state IDs.
Normally BACnet AI, BI, MI are created out of input source data points and AO, BO, MO
out of output source data points. The BACnet project settings allow changing this default to
BACnet value objects AV, BV, MI. In the auto-generate preview the user can review and
change those object types individually before generating the data points.
The type of the created BACnet server object depends on the type of the live value I/O data
point. If e.g. a universal input (UI) is used for measuring an analog value, the type of the live
value (Input data point) will be Double and thus, an Analog Input (AI) BACnet object will
be created. Table 7 shows all possible native BACnet object types for I/Os.
A property relation ‘native’ (see Section 3.1.12) is added to the original L-IOB input or output
data point, which links to the created native BACnet data point. For an AO object, an
additional AI object is generated as the feedback value object. The data point of the AO
object has a ‘feedbackValue’ property relation that points to the feedback AI object. For BO
objects, a separate feedback object is not required, since a feedback value is already included
in the BACnet BO object.
For the STId Card Reader mode (see Section 3.5.2), the I/O live value type of the Card Data
input is an array of 40 nibbles which contains the last read Card ID in BCD encoding
(LIOB/MagCard). In this case, the first n BCD digits that form a number which can be
displayed by a BACnet float are written to the Present_Value of the created BACnet AI
object. An ASCII version of the entire BCD code is written to the Description property of the
BACnet object.
For the “Pulse Count” interpretation of inputs (see Section 3.5.1.4), it is possible to choose
between an analog input or an accumulator object in the Configurator. The main difference
is that accumulator objects can precisely represent 32-bit meter data while analog objects
suffer from a loss of resolution.
When using native BACnet objects for L-IOB outputs, the BACnet priority array concept is
used in the I/O operating mode ‘Auto’ for determining the physical output value. Other I/O
operating modes (‘Override’, ‘Manual’, ‘Disabled’, see Section 3.5.1.9) bypass the BACnet
priority array. The physical value is determined by the override value or manual value in this
case. The following L-IOB live value and configuration property data points, which can be
changed at run-time, are exposed to BACnet properties:
Input: For L-IOB inputs in ‘Auto’ mode, the input value is written to the Present_Value
property of the BACnet input object. When switching from another operating mode to
‘Auto’, the current input value is also written.
Output: The output value written by the controller application to the BACnet output
object is reflected at the automatic priority in the Priority_Array of the BACnet object.
The resulting Present_Value of the BACnet object is then written to the physical output
in ‘Auto’ mode.
OperatingMode:
I/O Name and Description: Initially, the BACnet server object name and description
are both set to e.g. ‘L1_1_UI1’ (for UI1), where the preamble is ‘L1_1’ for local I/Os
and ‘L2_1’ for an attached LIOB-55x device. In the Configurator, the BACnet server
object name and description can later be modified manually or synchronized with the
current I/O name and description.
PulseCountInit: If the BACnet object type is Accumulator and this L-IOB configuration
property is written (to reset the pulse counter), the value is also written to the Value_Set
property of the BACnet Accumulator object and vice versa.
Meta-Character Meaning
. Matches any single character.
Indicates a character class. Matches any character inside the brackets (for example, [abc]
[]
matches ‘a’, ‘b’, and ‘c’).
If this meta-character occurs at the start of a character class, it negates the character class. A
negated character class matches any character except those inside the brackets (for example,
^ [^abc] matches all characters except ‘a’, ‘b’, and ‘c’).
If ^ is at the beginning of the regular expression, it matches the beginning of the input (for
example, ^[abc] will only match input that begins with ‘a’, ‘b’, or ‘c’).
In a character class, - indicates a range of characters (for example, [0-9] matches any of the
-
digits ‘0’ through ‘9’).
Indicates that the preceding expression is optional: it matches once or not at all (for example,
?
[0-9][0-9]? matches ‘2’ and ‘12’).
Indicates that the preceding expression matches one or more times (for example, [0-9]+
+
matches ‘1’, ‘13’, ‘666’, and so on).
* Indicates that the preceding expression matches zero or more times.
Non-greedy versions of ?, +, and *. These match as little as possible, unlike the greedy
??, +?, *? versions which match as much as possible. Example: given the input ‘<abc><def>’, <.*?>
matches ‘<abc>’ while <.*> matches ‘<abc><def>’.
Grouping operator. Example: ([0-9]+,)*[0-9]+ matches a list of numbers separated by
( )
commas (such as ‘1’ or ‘1,23,456’).
Indicates a match group. The actual text in the input that matches the expression inside the
{ }
braces can be retrieved through the sequence \0, \1, etc.
Escape character: interpret the next character literally (for example, [0-9]+ matches one or
more digits, but [0-9]\+ matches a digit followed by a plus character). Also used for
\ abbreviations (such as \a for any alphanumeric character; see Table 9 below).
If \ is followed by a number n, it matches the n-th match group (starting from 0). Example:
<{.*?}>.*?</\0> matches ‘<head>Contents</head>’.
At the end of a regular expression, this character matches the end of the input. Example:
$
[0-9]$ matches a digit at the end of the input.
Alternation operator: separates two expressions, exactly one of which matches (for example,
|
T|the matches ‘The’ or ‘the’).
Negation operator: the expression following ! does not match the input. Example: a!b
!
matches ‘a’ not followed by ‘b’.
Table 8: Metacharacters in Regular Expressions.
Abbreviation Matches
\a Any alphanumeric character: ([a-zA-Z0-9])
\b White space (blank): ([ \\t])
\c Any alphabetic character: ([a-zA-Z])
\d Any decimal digit: ([0-9])
\h Any hexadecimal digit: ([0-9a-fA-F])
\n Newline: (\r|(\r?\n))
\q A quoted string: (\"[^\"]*\")|(\'[^\']*\')
\w A simple word: ([a-zA-Z]+)
\z An integer: ([0-9]+)
Table 9: Abbreviations for regular expressions
When performing a replace operation on an input text, match groups are used in the output
template. Match groups are delimited by curly braces containing a matching pattern. As an
example the regular expression {[0-9]?[0-9]}:{[0-9][0-9]} contains two match
groups. The first match group matches any combination of one or two digits. The second
matches any two-digit combination. To make the replacement effective, the entire regular
expression has to match. In the example the regular expression matches any one or two-digit
combination followed by a ‘:’ and by any two-digit combination.
Then the output is assembled by specifying an output template. In that output template, both
literal text and references to the match groups can be specified. The first match group is
denoted by \0, the second by \1 and so on. Using the output template ref\0-\1 on the
example expression, the following input texts will produce these results:
3.10 Scripts
LOYTEC devices that support scripting provide a JavaScript-based scripting engine. Scripts
are executed in a separate process on the device and are able to work with data points. The
Configurator provides script resources that constitute the base modules of scripting. Script
resources are embedded into the data point configuration and are deployed onto the device.
For more information on the scripting engine refer to Chapter 16.
This Chapter gives step-by-step instructions on how to commission the LOYTEC device,
create a data point configuration with network variables, BACnet objects, how to expose
those data points to the automation server, and how to maps data points to other technologies
in the universal gateway.
4.1 Installation
4.1.1 Software Installation
The LINX Configurator must be used to setup the data point configuration of the LOYTEC
device. The Configurator is installed as a plug-in tool for all LNS-based network management
tools as well as a stand-alone tool (for systems without LNS).
System requirements:
LNS 3.1 SP8 U1, LNS 3.2 TE SP5, OpenLNS (for LNS mode),
Windows 7, Windows 8, Windows 10 or Windows Server 2003 (32 bit), Windows
Server 2008, Windows Server 2012,
Internet Explorer 10 or higher.
The LINX Configurator can be downloaded from the LOYTEC Web site
http://www.loytec.com. When asked for the type of installation, there are two options to
choose from. Select Typical to install the required program files. Select Full to install the
LONMARK resource files along with the software. This option is useful, when the system does
not have the newest resource files.
To Register in LonMaker TE
2. Click Next until the plug-in registration tab appears in the Network Wizard. Select the
LOYTEC LINX Configurator (Version X.Y) from the list of Not Registered (see
Figure 14).
6. The selected device templates are added automatically and XIF files are copied into the
LNS import directory.
Note: If you are using multiple databases (projects) make sure you have registered the plug-in in
each project.
7. Under LonMaker Network Properties Plug-In Registration make sure that the
LOYTEC LINX Configurator (Version X.Y) shows up under Already Registered.
1 3
Figure 17: Data Point Manager Dialog.
Using the context menu on a folder, sub-folders may be created to organize the available
objects. If new objects are created automatically, they are usually placed in the base folder
and can then be moved by the user to any of his sub-folders. Note, that the folder structure
described above cannot be changed by adding or deleting folders at that level.
The context menu also allows editing folder properties. Choose Properties … from the
context menu to open a property editor. Change name and description there.
Scheduler: This folder is used for local scheduler objects. Each of these objects will
map to a local scheduler on the device’s network port. Configuring schedules through
these objects actually transfers schedule configuration data to the underlying scheduler
objects on the network port. To create a scheduler, select the folder and use the context
menu.
Alarm: This folder is used for local alarm server objects. Each of these alarm server
objects represent an alarm class, which other objects can report alarms to. Other devices
can use the alarm server object to get notified about alarms. To create an alarm server
object, select the folder and use the context menu.
Trend: This folder is used for local trend log objects. Each of these objects will be able
to trend data points over time and store a local trend log file. To create a trend log object,
select the folder and use the context menu.
Statistics: This folder contains registers, which provide communication statistics
specific to the network port.
Remote Devices: This folder is used to collect all remote calendars, schedulers, trend
logs, and alarm client objects, which were created from network scan data. For each
remote device, a subfolder will be created where the objects referencing this device are
collected.
To filter for data point names, enter a search text into the Datapoint Name Filter text box
and hit Enter. A drop-down list holds the previously used filters available. Filters can also
specify name patterns for sub-data points using a dot. Typing the first dot expands all filtered
data points to the first sub-level. Continuing typing after the dot then filters on names of those
sub-data points. For example, typing “sw.val” selects all data points having “sw” in their
name, then expanding to their first sub-level and filtering all sub-data points on that level
having “val” in the name. For complex name filters, regular expressions may be used (see
Section 3.9).
The list order can be changed manually by drag-and-drop. Select one or more data points and
drag them to the desired position in the data point list. The data points will get a new order
number.
The list can be sorted by clicking on one of the column headers. For example, clicking on the
Direction column header will sort the list by direction. Other columns display Datapoint
Name, NV name, SNVT, Object Name, object Type and Instance number, allocation
(Alloc) of server object (SO) and/or client mapping (CM), number of attached Client Maps,
and the data point unique ID. To apply the current sort order as the new data point order on
the device, right-click on the column header and select Renumber Datapoints.
Alternatively, select from the menu Tools Renumber Datapoints.
The OPC column provides check boxes for each data point. If checked, the respective data
point is exposed to OPC on the device. Deselect the check box, if a data points shall not be
exposed to OPC. Note, that deselected data points do not add to the OPC tag limit.
The Param column provides check boxes for each data point. If checked, the respective data
point is exposed to the parameter file. The PLC in and PLC out columns provide check-
boxes, which define if data points are visible inside the IEC61131 PLC program as input and
output variables.
New objects may be created in the selected folder by selecting New Datapoint command in
the context menu of the data point list. A plus sign in the list indicates that the data point
contains sub-points. Clicking on the plus sign expands the view.
If an entry in the data point list denotes a reference to another data point (e.g., a scheduled
value reference beneath a scheduler object), right-click on that item and choose Go to related
data point in the context menu. This will navigate your selection to the referenced data point.
For the alarming, scheduling, trending (AST) features, there are columns, which display
icons for data points that are attached to an AST function. See Table 10 for details.
The data points in this list are color coded to make general information visible to the user at-
a-glance. The color coding is described in Table 11.
The column arrangement in the data point list can be modified to increase oversight. Right-
click on a folder or into the column header and choose Configure Columns… in the context
menu. The dialog shown in Figure 18 allow modification of the column layout.
Click on the plus button to add columns, or the minus button to remove selected
columns. Use the up/down buttons to move the selected columns. It is also possible to drag
them to another position. Finally, click OK to accept the new columns layout or Cancel to
discard the changes. Click the button Restore Defaults to go back to the installation
defaults.
Poll on Startup: For input data points this property defines, whether the data point shall
be polled once at start-up. Poll-on-startup can be enabled independently of the poll cycle.
See Section 3.1.2.
Pollcycle: For input data points, this property defines the poll cycle in seconds. Set this
property to 0 to disable polling. See Section 3.1.2.
Receive Timeout: For input data points, this property defines the receive timeout in
seconds. Set this property to 0 to disable polling. See Section 3.1.2.
Min Send: For output data points, this property defines the min send time in seconds.
See Section 3.1.2.
Max Send: For output data points, this property defines the max send time in seconds.
See Section 3.1.2.
Send-on-delta: For output data points this property defines, if value updates shall be
sent only once they meet the COV condition of the data point. For analog data points the
analog COV increment is used. If not checked, updates are always transmitted according
to min and max send times. See Section 3.1.7.
Use Linear Scaling: If this property is enabled, the analog values are pre-scaled from
the technology to the data point. This scaling is in addition to any technology-specific
scaling factors. If enabled, the properties Custom Scaling Factor and Custom Scaling
Offset accept the scaling factors. See Section 3.1.7.
Custom Scaling Factor, Custom Scaling Offset: These properties only exist, if linear
scaling is enabled. They apply to analog data points only. See Section 3.1.7.
Notify on any COV: This property defines, if a data point shall trigger an update only
when the value changes or on every write. If this is enabled, consecutive writes with the
same value do not trigger an update. If you want to convey every write, disable COV on
the data point. For analog data points, it will disable the Analog Point COV Increment
and trigger an update on any change of value.
Persistent: This property defines, if the last written value shall be stored as a persistent
value. Persistent data points restore that value after a restart from the persistent storage.
See Section 3.1.4.
Default Value: This property defines a default value (see Section 3.1.3). Enter a default
value to enable this feature in the data point. Delete the value entirely to remove the
default value. If no default value is defined, this property reads “N/A”. The default is no
default value.
Historic Filter: This property allows defining historic filters for the scalar data point.
See Section 3.4.6.
Point Type: This is the base data point type, e.g., “Analog Datapoint”.
Direction: This is the data point direction. Use input, output or value as directions.
Network Unit: For analog data points this property contains the definition of an
engineering unit of the scalar value as represented on the network, e.g., “°C”. A human-
readable text for the engineering unit is displayed and can be entered. If the unit is known
by the Configurator as a convertible unit, it is displayed with a green checkmark (see
Section 3.1.13).
Unit SI: If the data point has a convertible unit, a unit representation in the metric (SI)
system can be chosen. If the SI unit system is active, all values are converted to this unit,
e.g. °C. For a non-convertible network unit this option is not available.
Unit U.S.: If the data point has a convertible unit, a unit representation in the U.S. system
can be chosen. If the U.S. unit system is active, all values are converted to this unit, e.g.
°F. For a non-convertible network unit this option is not available.
Analog Datapoint Max Value: For analog data points this property contains the upper
limit of the supported value range. Note that this does not define an alarm limit.
Analog Datapoint Min Value: For analog data points this property contains the lower
limit of the supported value range. Note that this does not define an alarm limit.
Analog Datapoint Precision: For analog data points this property defines the number
of decimals. ‘0’ specifies an integer value. Display units may use this to format the
floating point value accordingly.
Analog Datapoint Resolution: For analog data points this property defines the smallest
possible value increment.
Analog Point COV Increment: This property is valid for analog input data points. It
specifies by which amount the value needs to change, before an update is generated. If
every write shall generate an update even when the value does not change, specify 0 as
the COV increment. If any value change shall generate an update, set the Notify on any
COV property.
Active Text: For binary data points this property defines a human-readable text for the
active state (true).
Inactive Text: For binary data points this property defines a human-readable text for the
inactive state (false).
Current State Map: For multi-state data points this property defines the multi-state
map. It must be set to a valid multi-state map or it points to User/UndefinedStates. Click
on to assign a state map.
State Count: For multi-state data points this property defines the number of discrete
states.
State Text: For multi-state data points this property defines a human-readable state label
for each state.
Energy Aware: This option can be used to mark data points as EnPIs (energy
performance indicators). This information may be evaluated by third-party software in
order to filter data points. It does not affect data communication on the device in any
way.
If the usage count is larger than zero, choose the item Show Usage … from the data point
context menu. This opens up a report window showing the objects referring to the selected
data point. An example is shown in Figure 19.
Each line reveals an object using the data point. Select a line and click on the Go to data
point button . This will navigate yours selection to the reported object.
1. Click on the Configure button in the Current State Map property of a multistate
data point. This opens the multistate map manager as shown in Figure 20.
2. Select a Category and an existing state map in the State Maps list and click on Select.
Maps that are fixed and cannot be changed are marked with a lock symbol .
3. Expand a state map line to see where this state map is used. Select the usage and click
the Go to Data Point button . This navigates to the data point.
4. If a new multistate map shall be created, click the Create State Map button .
5. In the Create New State Map dialog enter a state map Name.
6. Then enter the desired number of states and edit the state texts as needed and click into
the list of states. Edit state IDs and texts to your needs. Pressing Enter goes to the next
line. Finally click the Save button.
7. Select the newly created multistate map and click the Select button. The selected map is
now assigned to the data point.
To configure favorites, select any data point from any location in the data point folder
hierarchy and drag it onto the favorites folder. This will create a data point link, which is
displayed in the data point list:
The link name can be edited to something different that the original data point name. The
contents of this folder are also available on the Web UI or the LCD UI. The link names are
displayed there. The data point links can also be individually exposed to the OPC server or
PLC program notwithstanding if their original source is exposed or not.
Furthermore, the user can create sub-folders in the favorites folder and beneath to build a
hierarchy of data point links. Folder links are, however, not allowed.
For editing links of favorites for a large number of data points, the Manage Favorites tab in
the property view area of the data point manager provides a fast solution. The data point tree
is replicated in that tab as shown in Figure 21. Select a folder and optionally click on the
button to include favorites in sub-folders. Enter a filter expression to Filter, which applies
to the favorite name. For example, enter ‘room1’ to display all favorites that contain this as
a sub-string.
To link favorites to other data points using the manage favorites tab, navigate to the desired
folder in the main folder tree of the data point manager and select the data point to be linked.
Drag the data point onto the Link Target column. For detaching links, use multi-select on
the desired favorites and click the detach button . On linked favorites you may click on the
button , which jumps to the linked data point in the data point list.
To link property relations to other data points using the manage relations tab, navigate to the
desired folder in the main folder tree of the data point manager and select the data point to be
linked. Drag the data point onto the Is related To column. For detaching links, use multi-
select on the desired property relations and click the detach button . On linked property
relations you may click on the button , which jumps to the linked data point in the data
point list.
Remove NV Information: For external NVs, this property contains the information on
the remote device and the NV selector on that device.
Remote Device ID: For external NVs, this property contains information on the remote
device by listing the program ID and location string.
Remote Device Address: For external NVs, this property contains the CEA-709
network addressing information to access the node, i.e., subnet, node, and NID.
Retry Count: For external NVs, this property defines the retry count. The default is 3.
Repeat Timer: For external NVs, this property defines the repeat timer in milliseconds.
The default is 96 ms.
Transmit Timer: For external NVs, this property defines the transmit timer in
milliseconds. The default is 768 ms.
LNS Network Path: If available from an LNS scan, this property specifies the LNS
network path of the device where the given NV exists.
LNS Channel Name: If available from an LNS scan, this property specifies the LNS
channel name of the device where the given NV exists.
a certain Present_Value. That correction offset is then added to the written data point
value, e.g., when received over a connection.
Get Active Priority: Set this check box to let the data point reflect the active priority of
the local or remote BACnet object. The priority is a number between 1 and 16. This
property is only applicable for commandable BACnet objects.
Allocate Server Object: This Boolean property defines, if a server object shall be
allocated for the data point. This option is useful, when a local server object shall be
allocated for a client mapping.
Allocate Client Mapping: This Boolean property defines, if a client mapping shall be
allocated for the data point. This option is always set, if at least on client mapping is
attached.
Client Map Count: This property defines the number of client mappings attached to a
data point. A data point can have one read client map or n write client mappings.
Client Map [n]: This is a list of client mappings. The property shows a summary of the
client mapping parameters.
Client Confirmed COV: This Boolean property defines, if a client map subscribes with
the confirmed COV service. If not enabled, the unconfirmed COV is used.
Client Map Type: This property determines the type. It can be one of the following:
Poll, COV, Auto, Write, or Value (see Section 3.7.1).
Client Write Priority: For a write or value client map, this property defines which
priority is used for writing.
Remote Instance Number: This property specifies the object instance number of the
remote server object. The object type cannot be edited.
Value Read Mode: For value client mappings, this property defines the read mode: Poll,
COV, or Auto.
BACnet Notify Type: When set to ‘default’ the Notify_Type property is to be written
by the OWS. Change this to ‘Event’ or ‘Alarm’ to set the property via the data point
configuration.
BACnet Notification Class: If notify type is non-default, this property is enabled. It sets
the Notification_Class via the data point configuration.
BACnet Event Enable (To-XXX): If notify type is non-default, this property is enabled.
It sets the Event_Enable property via the data point configuration.
4.3.1 General
The general tab of the project settings as shown in Figure 23 contains settings independent
of the technology port. The settings are:
Project Name: This setting allows entering a descriptive name for the project.
Parameters managed by: This setting defines, which instance is managing data point
parameters. As a default, parameters are assumed to be managed by LWEB-900 and the
Configurator does not download parameter values to the device. If changed to parameters
managed by Configurator, the Configurator downloads parameter values and merges
parameter changes back into the configuration. This setting does not affect L-IOB
parameters, which are always managed by the Configurator. For more information on
data point parameters refer to Section 3.1.5.
L-IOB: Always ignore L-IOB manual/auto differences: Set this check box to ignore
differences in the manual mode parameter of L-IOB I/Os.
Device Configuration Download Default: This group of settings defines, how the
download of device configuration parameters shall proceed. If Download only data
point configuration is selected, the configuration download does not download
anything else than the data point configuration. If Ask is selected, the download will pop
up a dialog in which the user can choose what to download. If Download specific is
selected, the project settings of this dialog determine what is downloaded onto the
device. The individual items to download are selected by individual checkboxes below
the download option. As a default, the configuration download includes the schedules
and calendar patterns as well as L-WEB projects.
Background polling: Activate this option to permanently poll data points, even if they
have no pollcycle assigned. The data points are polled one-by-one. The poll rate can be
configured. This setting is not active by default. For more information on background
polling refer to Section 3.1.2.
Data Point Units: This setting defines which unit system is active in the Configurator.
Depending on the active unit system, SI units are displayed or U.S. units, as defined per
data point. This setting, however, influences only the display in the Configurator. If the
device shall be configured to run on this same unit system, set the check box This unit
system will be set on device on download. In this case each configuration download
will ensure the device runs on the selected unit system.
Important! If this effectively changes the unit system on the device, all persistent values are reset to
their default values converted to the respective unit system.
Auto snapshot: This setting is off by default. It can be enabled in the drop-down box by
selecting a time interval, which is used by the Configurator to produce configuration
snapshots. The user can jump back and forth between those snapshots. Snapshots can
also be made explicitly by clicking the snapshot button in the tool bar.
Value Data Points: Select this option to create data points in the old style with “_Read”
(input) and “_Write” (output) data points. Old configurations will have this option set to
continue creating data points using the same style. Newly created configurations should
not use this setting.
A Separator character can be defined, which is inserted between the data point name
components. As a default the underline ‘_’ is configured. The Preview shows how names
would look like with the chosen separator and name components.
The CEA-709 data point naming rules (see Figure 25) work on scanned network variables.
The preview shows how names would look like, when the check marks are modified. Note,
that changing the name components does not change already scanned NVs; this setting affects
only new scan results.
Use programmatic name, Use display name: This option decides how the data point
name is extracted from the NV. The programmatic name is the NV name from the XIF
file and is limited to 16 characters. The display name may be extracted from LNS, which
allows displaying a different, longer name than the programmatic name.
Add Subsystem Name via Filter: This line can be edited by adding LNS sub-system
components to the data point name. Click on to add another component. The first
subsystem1 is the one containing the device, the second subsystem2 the one containing
subsystem1, and so on. Click on the arrow symbol for editing a filter expression, which
defines how the sub-system text is transformed to the name component, e.g. copy the
last three characters. Examples for regular expressions can be inserted by clicking the
question mark symbol and selecting a transformation. In the preview section the filter
expression can be tested against an example text. For more information on using regular
expressions please refer to Section 3.9.
Under the port configuration tree, the user can enable or disable communication protocols on
the device’s ports. Enabled protocols are marked with a checkmark. Click on the checkmark
and toggle it. Note, that depending on the device model communication protocols on other
ports may be disabled.
The IP address settings cannot be changed in this dialog. The FTP server can not be disabled
in this dialog, either. This ensures that the Configurator can maintain connection to the
device.
The Upload button can be used to get the current device settings from the device and display
them in this dialog. The Download button can be used to explicitly transfer the settings from
this dialog onto the device. Those changes will be visible immediately on the Web UI but
take effect only after a reboot of the device.
Important! After downloading the device settings from this dialog the changes will be visible
immediately on the Web UI but the device needs to be rebooted to let the changes take
effect.
The Date/Time section allows defining automatic time zone configuration on the device
using the PC’s time zone database. Select the Enable automatic Time Zone and DST check
box and choose the appropriate setting from the drop-down list below as shown in Figure 27.
The timezone offset, start and end of DST are then configured accordingly on the device.
4.3.4 OPC
This tab is shown in Figure 28. It provides fields to configure OPC server tag naming and
poll timings.
Automatically structure imported data points for faster OPC browsing: This option
enables the automatic generation of sub-folders when using data points on the device. A
sub-folder is created for each scanned or imported device. This allows OPC clients to
browse the OPC tags in a hierarchical way.
Use delayed response: Devices with OPC clients can be configured to use delayed
response subscriptions. This is activated as a default.
OPC Pollcycle: If no delayed response is configured, this setting specifies the OPC
pollcycle.
Wait Time: If delayed response is configured, this setting defines the requested time to
wait for a change until a poll response is received. It effectively implements a heart beat.
Hold Time: If delayed response is configured, this setting defines the requested time to
hold back with poll responses. It effectively limits the traffic.
If the LOYTEC device is not yet connected to the network, go to the Model menu and select
the device model to be configured. If the device is already connected to the network it is
recommended to connect the Configurator online to the device.
1. Select the direct connection method by clicking on the Connect to device button
in the tool bar of the main window. The connect dialog as shown in Figure 30 opens
containing the managed device connection templates.
2. To add a new device connection, click on the New Device Connection button or
select an existing connection in the tree on the left-hand side and click on the Duplicate
button .
4. Enter the admin password. The default password is ‘loytec4u’ (older firmware versions
used ‘admin’).
b. TCP/IP: This uses the IP protocols FTP and Telnet or SSH to connect to the
device.
6. For IP-based connection methods enter the host name or IP address of the device.
Optionally, click on Use secure connection to enable encrypted SSH or HTTPS access
to the device.
7. If your device is located behind a NAT router or firewall, you may change the FTP,
Telnet, SSH, HTTP and HTTPS ports to your needs for accessing the device.
8. If the CEA-709 connection method is used, enter the CEA-709 address information and
choose a network interface.
Note: If you connect without having the connection settings saved, a dialog asks whether to use the
changed settings temporarily for this connection only. In this case the existing connection is
not altered.
10. Organize device connections into folders. To add a new folder, click on the New Folder
button and enter a folder name. Drag the new device connection onto the new folder.
To Upload a Configuration
in the tool bar. The configuration upload dialog opens up as shown in Figure 31.
2. If the check box Automatically sync local dynamic NVs is enabled on a CEA-709
device, the Configurator uploads any manually created dynamic NVs and merges them
into the data point configuration.
3. Click on the button Start to start the transfer. This will upload the configuration of all
ports.
4. When the project settings of the configuration being uploaded specify to ask, which
specific parameters shall be uploaded, check the needed information and proceed.
5. If parameters are selected to be uploaded and their values have changed on the device,
the parameter merge dialog appears. For resolving the reported conflicts refer to Section
3.1.5.
2. Right-click in the data point list and select New Datapoint… in the context menu. This
opens the register creation dialog as shown in Figure 32.
3. Enter a Datapoint Name for the register. You may leave the Register Name blank to
give the underlying register the same name as the data point.
4. For analog registers choose appropriate units for the metric (SI) and U.S. unit systems.
To specify a non-convertible unit type in the desired unit as a free text.
5. The standard setting is a value data point for read/write. Optionally, deselect the value
option and select the read data point or write data point check box. This is necessary
when configuring for an older firmware version.
6. Select Create as Parameter if needed. In this case, the register will be a persistent
parameter. It can be done later in the data point properties also.
8. When selecting User, a register with a user-defined structure is going to be created. Click
on next to Custom Type in order to select a structure type.
9. In the dialog Select Custom Type choose the type Category in the drop-down list and
the desired user type. Then click the button Select.
11. If needed create additional registers from the dialog. Finally, click Cancel to exit the
dialog.
To Download a Configuration
in the tool bar of the main window. This will open the configuration download dialog as
shown in Figure 33.
2. If the project settings specify to ask (see Section 4.3.1), which specific parameters shall
be downloaded, check all that apply and click Ok.
3. Click Start to start the download. Each of the actions is displayed in the Task List
section of the dialog. The current progress is indicated by the progress bar below.
4. If parameters are selected to be downloaded and their values have changed on the device,
the parameter merge dialog appears. For resolving the reported conflicts refer to Section
3.1.5.
5. When the download process has finished, a notification window appears, which has to
be acknowledged by clicking OK.
in the tool bar. The upload system log dialog as shown in Figure 34 opens showing the
upload progress.
3. When the upload is finished, click on Show System Log. The system log window
appears as shown in Figure 35.
4. Click on Save to store the system log into a file on your local hard drive.
To Create a Backup
3. A file requestor opens. Choose a location to store the ZIP file of the device backup. The
suggested file name contains device IP address and creation date.
To Restore a Backup
2. In the file requestor choose a backup ZIP file and click Open.
3. The Configurator restores and reboots the device. The process is complete when the
device has finished rebooting.
For analog data points with a convertible network unit, the Configurator provides two unit
representations, one to be used in the metric (SI) system, and one used in the U.S. system.
The value is converted from the network unit to the unit of the chosen unit system. When
creating analog data points, both unit representations are chosen from the network unit as
appropriate. One can adapt these settings to the project’s needs.
Since both unit representations can be specified, a project can be engineered to run in a metric
(SI) and U.S. environment. Even when using a fixed data point configuration on the device,
it can be switched to the desired unit system. All values on the device are processed in that
chosen unit system, including Web UI, OPC server, parameter file, global connections, and
programmable logic.
3. Under Unit setting choose U.S. in the drop-down box. The check box This unit system
will be set on device on download is set as a default. This ensures the device will run
on the chosen unit system.
4. Click OK.
2. On existing analog data points, choose the appropriate U.S. unit in the data point
properties. Compatible units to the network unit are shown first. The active unit system
is indicated.
3. Enter all analog values such as default, min/max values, etc. in U.S. units. The unit is
indicated next to the data point property.
1. On the General tab of the Project Settings dialog, deselect the check box This unit
system will be set on device on download. Choose your unit system of preference to
be used in the Configurator for the project design.
2. Create data points and choose both appropriate units for metric (SI) and U.S. unit
systems.
3. In program logic evaluate the system register Unit System in order to select appropriate
sets of coefficients for regulators.
4. Download the data point configuration to the device. The device can be switched to the
desired unit system using the Web UI or the system register Unit System Set.
Important! When changing the unit system, the device needs to be rebooted and will reset all persistent
values to their default values converted to the chosen unit system.
4.5 Connections
4.5.1 Create a New Connection
After having configured the device’s network ports with data points, internal connections
between those data points can be created. Usually, the manual method to create a connection
is used to create connections between different named data points.
A connection is an internal mapping in the device between input and output data points. A
connection always consists of one or more data points. A value update from an input data
point (sender) is distributed to all output data points (receivers). A status change of a receiver
data point is propagated back to all sender data points. All data points in the connection must
be of a compatible type or use an adaptor.
By adding data points as sender and receiver to the same connection, they transfer values in
both directions. Doing so with connected data points, bi-directional connections can be built.
2. in the main window and press the speed button Create new Connection. In the menu
choose Standard Connection. A new connection is added to the connection list.
Rename the connection if you want to do so.
3. Over the list Datapoints in connection on the right-hand side click on Attach Data
Point to add data points for this connection. This opens a list of all available data points.
Select one and press OK. You may use multi-select to select more than one data point
at a time.
Note: By default only compatible data points are displayed. Sometimes compatible data points are
available as member points (e.g., a SNVT structure member). Click on to expand the data
point and select the desired member point.
4. Now the connection tab contains the new connection and below the list of data points in
that connection as shown in Figure 36.
5. Change the direction by modifying Send or Receive. For changing multiple data points
use multi-select. Optionally, select Disable to temporarily exclude this data point from
communication in the connection.
6. For receive items you may optionally define a forward Delay in seconds (see Section
3.3.5).
7. If the attached data point needs a conversion, the item displays a yellow exclamation
mark and the default conversion (e.g. ‘Analog to CEA-709/motor_state_t’). By
clicking on the button to view the current conversion.
8. To add a new conversion to this item, click on the button. A dialog opens, which
displays the matching adaptors already available in the library as shown in Figure 37.
9. Select an existing conversion, click the plus button to create a new conversion, or
click the edit button to modify an existing conversion.
10. An example for editing an analog to multi-state value conversion is shown in Figure 38.
Enter a Conversion name, then edit the Value range from column and select the desired
Target state mapping.
11. Click Save and then choose the newly created conversion by clicking Select.
12. The items with an assigned value conversion appears with a green checkmark .
1. Change to the Datapoints tab of the main window and navigate to the data point that
shall be put into the new connection.
2. In the properties view below the data point list click on the Local Connections tab as
shown in Figure 39.
3. Then simply drag a data point from the data point list and drop it onto an empty area in
the connections list as shown in Figure 39.
4. To add data point to that connection, drop the new data point into the empty area in the
connected data points list below.
1. Start the connection by adding a data point. A value data point is added as Send to a new
connection.
2. Then add the same data point a second time and do not create a multi-slot connection.
This time it is added as Receive. This makes the data point send to and receive values
from the connection.
3. Continue by adding the data point, which shall be connected. A value data point is added
as Receive to an existing connection.
4. Then add the same data point a second time to that connection. This time it is added as
Send.
5. Now both data points send values to and receive values from the connection. This
synchronizes value changes back and forth between the involved data points. Update
loops are suppressed by the connection. It is not necessary to set a COV on any of the
involved data points. An example is shown in Figure 40.
5. If connections that are not part of the connection CSV file shall be deleted, click Yes
when prompted. Click No if the other connections shall be left as is.
7. When the import has completed, optionally view the log to check, which connections
have been added, modified, and deleted.
To Edit a Connection
2. Select the connection to edit. Then follow the steps as applied when creating a
connection.
3. To detach a data point from the selected connection, select the data point and click on
the button Detach selected data points over the connection member list.
4. Change the direction of a data point in the connection by choosing one from the Dir
drop-down. You may select Disable to temporarily exclude this data point from the
connection altogether.
1. Change to the Datapoints tab of the main window and navigate to the data point for
being added.
2. In the properties view below the data point list click on the Connections tab as shown
in Figure 42.
4. Drag the selected data point and drop it into the empty area of the Datapoints in
connection list as shown in Figure 42. This adds the data point to the selected
connection.
5. To replace a data point in a connection drop the new data point right onto an existing
data point in the connection that shall be replaced.
To Delete a Connection
2. Select the connection for removal. Use multi-select to select more than one connection.
1. Change to the Datapoints tab of the main window and navigate to the data point to be
connected.
2. Select a structured data point and drag it into the connections list to create a new
connection.
3. A dialog prompts the user, whether to create a multi-slot connection or use the user data
point as a single entity in the connection. Choose Yes to create a multi-slot connection.
4. A multi-slot connection is created as shown in Figure 43. The multi-slot connection can
be collapsed or expanded. In the expanded view it shows all slots. Select the top-level
multi-slot connection to view all data points in the connection. Select a single slot
beneath to view only those data points in that slot.
5. Add more slots by dropping data points onto the top-level multi-slot connection
‘setting1’.
6. Connect other data points to the slots by dropping them onto the slots. For example
connect the register ‘regRotation’ by dropping it onto ‘setting1.rotation’ as depicted in
Figure 44.
1. Create a multi-slot connection from a structured data point, e.g., the input data point.
2. Add output slots to the multi-slot connection, e.g. by adding a structured output data
point. An example is shown in Figure 45.
3. Click on the Create math adapter from connection button. The dialog Edit Multi-
Slot Math Adaptor opens as shown in Figure 46.
5. For each output enter an Output Value Formula. This can be done by directly typing
the formula or by clicking the edit button .
6. Optionally, etner an enable formula into Write Output if Formula en > 0. As a default
enable is ‘1’.
2. in the main window and press the speed button Create new Connection. In the menu
choose Connection with Math Adaptor.
3. In the dialog Select Multi-Slot Math Adaptor select an existing adaptor and click
Select. A new multi-slot connection is added to the connection list with empty slots as
depicted in Figure 47.
4. Now connect data points by dragging and dropping them onto the empty slots in the data
point list below.
If other devices already have global connections configured that publish data on the network,
their definition can be exported and imported into the new configuration. That will make all
the global connection names available. When creating manually, the connection names can
be edited.
2. in the main window and press the speed button Create new Connection. A new
connection is added to the connection list.
3. Define a name for the global connection. This name is required to be unique on the
network. Data will be published or subscribed to under this name.
4. Add data points to the global connection as described in Section 4.5.3. As a default,
output data points will be added as sending, input data point as receiving data under the
global connection.
5. Change the direction by modifying send or receive. For changing multiple data points
use multi-select.
6. Define timing parameters for a global connection that is sending out data. On the global
connections tab of the main window the connection properties are listed below the data
point member list. In the tab of the property area click the button .
7. To export the definitions of the created global connections, click the button Export
connections to disk and choose the XML format.
8. To use those definitions, click the button Import connections from disk and choose
an exported connections XML file. This creates the global connections structure with
connection names but without any data points. Data points can then be added, for
example, via drag-and-drop.
2. Select those data points of a given port folder that shall be mapped to another technology.
The methods innclude sub-folders, data point name filter and multi-select may be used
for doing this.
3. Click on the speed button Generate and connect selected in the tool bar.
4. Alternatively, you can select the port folder or any sub-folder and click the speed button
Folder-wide Generate points and auto-connect in the tool bar. This generates target
data points and connections for all data points in the folder.
5. The auto-generate preview dialog opens as shown in Figure 49. Choose the target
technology. The preview results show a list for each source type found how it will be
created as a target type. The Type Name column provides a drop-down to modify the
result. This choice is remembered and will be applied the next time again. You may click
the Restore defaults button to revert all custom settings.
Note: The respective port may have to be enabled first in the project settings to have the target
technology available in this dialog.
6. If the selected target technology offers choices on the direction to create, choose one of
the offered directions.
7. Structured data points will be flattened in some target technologies. To prevent this from
happening, click the Don’t expand structured data points button . Note, that this
may require an auto-generate template, which defines how to map this structured data
point.
Note, when auto-creating the target data points, the Configurator initializes their properties
with default values derived from the properties of the source data points. In particular, the
data point name, description, minimum and maximum value, and engineering units are
generated. If the default properties do not have the desired values, the user can edit them in
the target folder. The user can also craft an auto-generate template where those properties are
pre-set.
To auto-generate target data points into multiple technologies from the same source data
points, execute the auto-generate and connect function multiple times on the source data
points. Select different target technologies in sub-sequent auto-generate actions. The new
data points are added to existing connections. This makes it easier to keep track of auto-
generated local connections involving multiple technologies.
1. Select the source data points and invoke auto-generation as described in Section 4.5.8.
2. In the preview dialog select the source type for which a new template shall be created
and click the Create template for selected source button.
3. The auto-generate template editor opens as shown in Figure 51. It contains two data point
lists. The left-hand (denoted ‘1’) list is pre-filled and contains the selected source data
points. They are locked and cannot be modified. The right-hand list (denoted ‘2’) is
intended for creating the desired target data points.
4. Enter Name and Description, which is used later to select the auto-generate template.
5. Right-click in the target data point list and select Create Data Point …. The creation
dialog of the respective target technology opens. Create the desired target data points,
e.g., a BACnet ‘MO’ data point with a custom multi-state map.
6. Edit the target data point name to use a variable placeholder for the target data point
name such as %{name}. Insert the placeholder by selecting the desired entry of the add
var drop-down list. When applying the auto-generate template, the placeholder is
expanded to the name of the actual source data point. Choose %{path}%{name} to
flatten the folder tree of the source data point and include the path in the target data point
name.
7. Drag and drop the source and target data points into the Connections tab below to create
the needed connections. Add custom conversions to the connection items as needed.
9. From now on it can be selected in the Template column and applied to the source.
For example, there are device folders of similar devices on the BACnet port. These shall
serve as the connection source. One such device folder contains three analog data points
named ‘TempComfort’, ‘TempNight’, ‘RoomTemp’ that have ‘°C’ as engineering units.
These shall generate two target data points, one a structured data point with the setpoints
‘TempComfort’ and ‘TempNight’ connected (e.g. a SNVT_temp_setpts) and one data point
with the ‘RoomTemp’ connected (e.g., a SNVT_temp). A complex auto-generate template is
created based on one of the device folders.
1. Select the source folder and invoke auto-generation as described in Section 4.5.8 using
the button Folder-wide Generate points and auto-connect in the tool bar.
2. In the preview dialog choose generation based on folder templates only. The list will
then be empty as no such template yet applies. Then click the Create template for
selected source button.
3. The auto-generate template editor opens as shown in Figure 51. It contains two data point
lists. The left-hand (denoted ‘1’) list is pre-filled and contains the selected source data
points. They are locked and cannot be modified. The right-hand list (denoted ‘2’) is
intended for creating the desired target data points.
4. Enter Name and Description, which is used later to select the auto-generate template.
5. Right-click in the target data point list and select Create Data Point …. The creation
dialog of the respective target technology opens. Create the desired target data points,
e.g., a SNVT_temp_setpts and a SNVT_temp.
6. Edit the target data point name and local NV name. Since the source data point names
will be equal for all source folders, an additional component may be added to the target
data point name. Use the variable placeholder %{path} in the name to make it unique.
Insert the placeholder by selecting the desired entry of the add var drop-down list. When
applying the auto-generate template, the path placeholder is expanded to the actual folder
path relative to the Datapoints folder.
7. Drag and drop the source and target data points into the Connections tab below to create
the needed connections. Add custom conversions to the connection items as needed.
9. From now on it can be selected in the Template column and applied to matching source
folders.
The Configurator provides a resource manager, that can be used to view, edit, import and
export connection resources. Select the menu Tools Manage Connection Adaptors …
or Tools Manage Auto-Generate Templates … to open the resource manager dialogs.
1. Under the Global Objects folder, select the E-mail Configuration sub-folder.
2. Right-click and select New E-mail Template … from the context menu.
3. In the Configure E-mail Template dialog, which is shown in Figure 52 enter the To
address and the Subject. Optionally, Cc and Bcc addresses can be specified.
5. If the e-mail text shall contain values of data points, add data points to the Data Sources
list by clicking the Add… button.
6. A data point selector dialog opens. Select one or more data points and click OK. The
selected data point appears in the Data Sources list.
7. If necessary, edit the Format string. The default ‘%.2f’ will format the value as a floating
point with 2 decimals. You may choose a different format string from a drop-down list
of pre-defined formats, including date/time formats.
8. Select the data point in the Data Sources list. In the drop-down box underneath select
Selected Data Source Value, in the next drop-down select to text click the Paste button.
Variables can also be pasted to the subject line or any of the address lines.
9. A place holder %{v1} for the data point value appears now in the e-mail text (see Table
4 in Section 3.4.5).
10. To replace an existing data source select the data point in the Data Sources list and click
the Replace… button. This opens a data point selector dialog for choosing the
replacement data point.
Note, that the behavior of the trigger data point is influenced by the COV properties of the
data point. If the Only notify on COV property is checked, the data point triggers only if its
value changes to the value of the trigger condition. If that property is not checked, the data
point triggers on every write with a value that matches the trigger condition.
The trigger for sending an e-mail can be enabled or disabled altogether by using an enable
data point. This data point must be of type binary. If the value of that enable data point is
TRUE, the trigger conditions are evaluated. If the value of the enable is FALSE, no e-mails
are be triggered.
1. Under the Global Objects folder, select the E-mail Configuration sub-folder.
2. Right-click and select Configure E-mail Template … from the context menu.
Note: Of course, you can also change directly to the Mail Triggers tab when creating an e-mail
template.
6. The triggers appear now in the E-Mail Triggers list. The data points that serve as e-mail
triggers also appear with the e-mail icon in the data point list.
7. In the Manage Trigger Conditions you can setup the trigger condition depending on
the trigger data point class.
8. If the trigger condition is depending on the value of an enabling data point, you can add
an enable data point by clicking on the … button.
9. To remove such a trigger enable, click the Remove Enable Trigger button.
4.6.3 Attachments
E-mail templates can be configured to have file attachments. Basically, any file of the device
can be specified as an attachment.
To Configure Attachments
1. Under the Global Objects folder, select the E-mail Configuration sub-folder.
2. Right-click and select Configure E-mail Template … from the context menu.
Note: Of course, you can also change directly to the Attachments tab when creating an e-mail
template.
5. Click the Add button. The file appears in the Attachments list.
6. To remove an attachment, select the attachment file in the Attachments list and click
the button Remove.
higher than this setting, depending on burst rates. The default is 100 e-mails per day.
This results in an average interval of one e-mail per 14 minutes.
Send burst count: This setting defines how many e-mails may be transmitted shortly
after each other not limited by the above average interval. After the burst count, the
average mails per day limit takes effect. The default is a maximum of 20 e-mails in a
row.
1. Locate the calendar object. When using a generic scheduler the corresponding generic
calendar already exists in the Scheduler folder under the device folder. For a technology
calendar, select the Calendar sub-folder of the respective port.
5. Click Create Pattern. The dialog closes and the calendar pattern appears beneath the
calendar data point.
1. Under the device folder, select the Scheduler sub-folder to create a generic scheduler.
For a technology scheduler, select the Scheduler sub-folder of the respective port.
2. Right-click in the data point list view and select New Local Scheduler ….
3. Enter a name for the schedule and a description. Note, that the schedule automatically
detects a calendar, if it has previously been created.
4. Click Create Schedule. The new schedule appears in the data point list of the Scheduler
sub-folder.
This configuration must be done as an initial setup. The scheduled data points and daily
schedules can be changed later in the Web UI or over the network.
2. Right-click and select Configure Schedule from the context menu. The same dialog
which appears when a new scheduler is created is shown and allows configuring the
scheduler. Of course, this step can also be done directly when the data point is created.
4. Click the button Attach … . This opens another data point selector window.
5. Select the data points to attach and click OK. For each of the attached data points, one
or more lines appear in the list below the attach button. If the attached point is a structure,
there will be one line for each element of the structure.
Tip! Data points can also be attached to a scheduler by selecting a data point in the data point
manager, drag it onto a scheduler data point and drop it on the scheduler data point.
6. Enter a short text in the Description field in the second column of each line. This text
will serve as a label, which will be shown on the device’s UI to identify the data point.
7. Add new value presets by entering a name and pressing the Create button next to the
input field.
Tip! To generate presets automatically for multi-state data points, click the Auto-Create button.
This button is available, if no other presets have been defined yet.
8. For each new preset, a new column will appear in the list. In this column, enter the
desired value for each of the attached points, which will be set when this value template
is scheduled. The user may later edit the values for each preset on the device but cannot
add new value presets unless there is only one line (one value) in the list.
9. If there are multiple output values which belong together, they can be grouped in order
to save space on the device. For each group, the entered value is stored only once, even
if there are more data points in the same group.
10. When done with the point and value setup, switch back to the Configuration tab or click
Save Changes to leave the dialog.
Tip! A shortcut to creating a scheduler object and attaching a data point is to select a data point
in the data point manager, right-click on it and choose Schedule Datapoint from the context
menu. This generates a scheduler and links that data point to it.
In addition, scheduled events can be configured to occur on exception days from a calendar,
such as “Holidays”. An exception day always overrides a normal weekday. If more than one
exception day is used, a priority must be assigned. This is necessary so that the system knows
which schedule to follow on a day which matches more than one calendar pattern.
Considering the priorities the calendar preview shows the effective schedule on a given day.
1. Open the Configure Schedule dialog and click on the Configuration tab (see Section
4.7.3).
2. In the calendar view select the day for which to configure the scheduled event. Then
select the event duration by clicking into the daily planner and dragging the mouse to
the desired duration.
3. Then click on the button Create new scheduled event and enter a Name for the
scheduled event (note, in BACnet there is no name to be specified). Choose the
scheduled value or enter a scheduled value. Modify the Start and End time to your
needs. Optionally you should set a priority, if scheduled events overlap in the preview.
5. The click OK. The new event appears in the daily planner.
6. For viewing more details on overlapping events you can change to the day view . In
all views events can be extended or shrunk using the upper or lower boundary handles
or moved by clicking and dragging.
7. Right-click on an event in order to edit it. You can choose to modify it, change its color,
or delete it.
8. To set a default value, right-click onto the grey area right above the day planner. In the
context menu choose a default value.
1. For letting a scheduled event occur on exception days from a calendar, create a new
scheduled event.
2. Select the event type Calendar. and choose one of the defined calendar date entries.
3. Note, that if the scheduled event may overlap with other events. In this case edit the
priorities of the scheduled events. For example, if a given calendar day falls in both
categories, “Holidays” and “Maintenance”, the scheduled event with the higher priority
becomes effective. The highest available priority is marked highest. Note that the actual
priority values depend on the technology (see Section 3.6.4).
Important! Choose different priorities for different scheduled event. If two scheduled events overlap
and their priorities are equal, it is not determined, which value is in effect.
in the tool bar of the main connections window. Click OK when the upload is finished.
2. Select the Calendar sub-folder and select the calendar pattern, which shall be configured
4. The Configure Pattern dialog appears as shown in Figure 53. Add dates to the calendar
pattern by entering a Date Configuration. Then click Add Entry. The date appears in
the Pattern Entries list on the right-hand side.
5. Edit an exception by selecting the pattern entry in the Pattern Entries list. Then modify
the date configuration in the Date Configuration group box.
6. Click Save Changes when all exception days have been entered.
Tip! If not sure, how a date configuration affects the calendar days, click on a pattern in the
Pattern Entries list and the affected days will be highlighted in the Preview.
Scheduler Enable/Disable Datapoint: This data point can be configured, which enables
or disables the scheduler depending on its Boolean value.
Enable/Disable Feedback Datapoint: This data point is updated with the current
enabled state of the scheduler. This also reflects and an enable from the network.
Scheduled Preset Name: This data point can be attached to be updated with the name
of the currently active preset. Only string data points can be attached.
3. In the Control Datapoints group box, click the button to add the desired control
data point. A data point selection dialog opens.
4. Select a matching data point and click OK. For the preset name a string data point must
be selected.
Next state: This is the next, future occupancy state in the schedule.
Time to next state: This part reflects the time in minutes until the next state becomes
active.
To Use a SNVT_tod_event
1. Under the device folder, select the Alarm sub-folder to create a generic alarm server.
For a technology alarm server, select the Alarm sub-folder of the respective port.
2. Right-click in the data point list view and select New Alarm Server ….
3. In the Create New Alarm Server dialog box (as shown in Figure 54) enter Name and
Description of the alarm server.
4. For alarm transitions you may define, which require acknowledgement and at which
priority they are reported.
5. You may attach data points for storing alarm counters. These will be linked using the
respective property relations (see Section 3.1.12).
6. When you create a generic alarm server, you may add technology alarm servers, that
shall be reported to. Click on and choose one alarm server of each technology. If they
don’t exist, you need to create them under the technology port folders.
7. Click Create. The alarm server appears now in the data point list view.
8. For a BACnet technology alarm server, edit the instance number of the Notification
Class object to your needs.
2. Right-click and select Create Alarm Condition… from the context menu.
3. For the alarm condition edit the following definitions, which apply to all condition types
as shown in Figure 55. Select the Alarm Server which the alarm shall be reported to.
Typically, you will choose a generic alarm server.
4. Enter an Alarm Message. This is shown when the alarm becomes active. You may add
variable placeholders to this message by selecting one from the drop-down box add var
on the right-hand side. Enter a Clear Message. This is shown when the alarm clears. For
analog alarms, the alarm message is split into a low-limit (LO) message and a high-limit
(HI) message, respectively.
5. Check the option Enable Fault Alarms, if fault conditions (offline, unreliable) shall
generate fault alarms. If enabled, enter a Fault Message, which is displayed along with
the fault alarm when it occurs.
6. Optionally, enter a Time Delay, for which the condition must persist before the alarm
becomes active or is cleared again. The delay is entered in seconds.
7. By clicking you may attach a data point, which is evaluated for enabling the alarm.
This can also be done by editing the property relation ‘enableAlarm’ (see Section 4.2.8).
Detach the data point by clicking .
8. Choose the option value is different from to define a feedback alarm. In this case the
setpoint value of the alarmed data point is compared against the feedback value. A
feedback data point can be attached for this purpose. This can also be done by editing
the property relation ‘feedbackRelation’ (see Section 4.2.8).
9. Choose the option value has condition to define a value alarm. In this case the data
point value is compared against the condition. Edit the condition in the box below this
option.
10. For an analog feedback condition fill in the alarm condition as shown in Figure 56. A
feedback alarm is generated, if the setpoint differs by – and differs by + value from the
feedback value. Enter a Deadband to account for hysteresis. Attach or detach data points
for those limits. This can also be done by editing the property relations ‘lowLimit’,
‘highLimit’, and ‘deadband’, respectively (see Section 4.2.8).
11. For an analog value condition fill in the alarm condition as shown in Figure 57. Select
Low Limit and High Limit and put check marks, if they shall be employed. Enter a
Deadband to account for hysteresis. Attach or detach data points for those limits. This
can also be done by editing the property relations ‘lowLimit’, ‘highLimit’, and
‘deadband’, respectively (see Section 4.2.8).
12. For a binary data point define an alarm value in the alarm condition as shown in Figure
58. Select the Alarm Value which triggers the alarm.
13. For a multi-state data point define the alarm values in the alarm condition as shown in
Figure 59. Select the states in the list Not Alarmed and move them to Alarm on States
by clicking the arrow buttons.
14. Click on Create. In the alarm column, the alarm sign will be added for those data
points that have an alarm condition. If a sub-data point has been alarmed, the top-level
data point will indicate this with the sign .
template can be created and the alarm point attached as a trigger. The e-mail template can be
configured to contain certain alarm information in the text or subject field.
4. In the Mail Triggers list select the added trigger data point.
5. In the Manage Trigger Conditions list put a check mark on alarm conditions that shall
invoke the transmission of the e-mail. See Table 12 below for different combinations of
alarm state trigger conditions.
7. Add the alarm data point as a data source as described in Section 4.6.1.
8. Choose the desired alarm information from the fields in the drop-down Selected Data
Source Value and paste a place holder into the e-mail text or subject field.
Action State to
Alarm Active
Acknowledge Ackd-Active + Ackd
Clear Ack-Pending + Inactive
Table 12: Alarm state triggers
An alarm log can log transitions of one or more alarm objects. Its size is configurable. The
alarm log can be operated as ring or as linear buffer. When operated as ring buffer, the oldest
alarm log records are overwritten by new alarm transitions, as soon as its size limit is reached.
When operated as linear buffer no more alarms are logged once the log is full.
1. Under the Global Objects folder, select the Alarm Log Object Configuration sub-folder.
2. In the data point list right-click and select New Alarm Log … from the context menu.
3. In the New Alarm Log dialog enter a Name for the alarm log. Optionally enter a
Description.
4. Enter a Log Size, which defines how many transitions are resident in the alarm log.
5. Select the desired Fill Mode. The default is Ring Buffer, which lets the log overwrite
old records once it reaches its capacity. Select Linear Buffer, if recording shall be
stopped in this case. The user has to purge the log before it continues recording.
6. Define a percentage for Fill Level Notification, which can be used to trigger the
transmission of E-Mails.
7. Click on the button Add… on top of the Logged Alarm Objects list.
8. A data point selector dialog opens. Select one or more alarm objects that shall be logged
and click OK. The alarm objects appear in the list.
Configure Alarm Conditions: Use this option from the context menu on a multi-
selection of data points. The alarm condition of all selected data points can be edited. If
all selected data points are of the same class (e.g., all analog data points) the alarm
condition can be fully specified. Note that these settings will be applied to all data points.
In alarm messages use variable place holders. For assigning different limit and enable
data points use the manage relations tab (see Section 4.2.8).
Configure Alarm Messages: Use this option from the context menu for editing alarm
messages (alarm, clear, fault) for all data points in the selection. A dialog with a
spreadsheet view appears as shown in Figure 60. Edit the messages directly in the
spreadsheet. Alternatively, click on the export button to export the spreadsheet as a
CSV file for editing in Excel. Import a CSV file with alarm messages in the menu Tools
Import alarm messages.
Note: Use the feature to include data points from sub-folders and filter expressions to expand the
ability to perform a multi-select.
Trend objects can generate trend logs for single and multiple data points and can be operated
in one of the following modes:
Interval Mode: In this mode a snapshot of all trended data points is logged into the data
logger file. Aligned log intervals can be configured.
COV Mode: In this mode, each of the trended data points is logged separately, if and
only if its value changes. For analog data points, a specific COV increment can be
configured in the data point configuration properties of the trended data point.
Trigger Mode: In this mode a snapshot of all trended data points is logged each time a
trigger condition fires. The trigger condition is applied to a trigger data point.
2. In the data point list right-click and select New Trend … from the context menu.
3. In the Create New Trend Object dialog (shown in Figure 61) enter a name and
optionally a description for the trend log object.
5. On devices with SD cards or USB memory, select External trend storage, if this trend
log shall be backed up to an SD card or USB memory. If doing so, also set the Fill Level
Notification, which triggers when a backup is written to the external storage. The storage
device can be mounted and enabled on the removable media Web interface of the device.
6. Select the Log Size. The display in the dialog will adapt the estimations for needed data
logger file size in KB and duration of the trend log. Alternatively, for interval trends, the
estimated log duration and log interval can be edited.
7. In the interval trend mode the Align interval option can be activated. Depending on the
selected interval, the beginning of the interval is aligned to the wall time (e.g. every 15
minutes aligned to the top of the hour). An additional offset in seconds to that alignment
can be specified (e.g. 5 seconds after those 15 minutes).
8. Select a Fill Level Notification percentage. This will decide at which fill-level trigger
will fire. A fill-level trigger can be used to trigger the transmission of an e-mail (see
Section 4.9.5) or a backup of log data to the external storage.
9. Click Save changes to store the basic configuration of the trend object. The new trend
log object appears in the data point list of the Trend folder.
The trending can be enabled/disabled on behalf of an enable data point. This data point should
be of type binary. If the value of that enable data point is TRUE, the trend object logs data
as defined by the trend mode. If the value of the enable is FALSE, trending is disabled. If no
enable data point is configured, the trend log is always enabled.
2. Right-click and select Configure Trend from the context menu. The same dialog which
appears when a new trend object is created is shown and allows configuring the trend
object. Of course, this step can also be done directly when the object is created.
3. Add data points to be trended. Click on Add … which opens a data point selector
window.
4. Select the data points and click OK. For each of the attached data points, a line appears
in the list below the add button. The trended data points will also appear with the trend
icon in the data point manager.
Tip! Data points can also be attached to a trend by selecting a data point in the data point
manager, drag it onto a trend object and drop it on the trend object.
6. If COV mode was selected, the COV increment is displayed in the COV delta column.
This value can be increased to produce less trend data. Note, that it cannot be lowered
under the trended data point’s own COV increment. Go to the data point configuration
to change the COV increment in this case.
7. If the trended value of the data point shall be aggregated over the log interval, select the
desired aggregation in the Type column. Available options are Min, Max, Avg.
Tip! For creating multiple curves with min, average, and maximum values, add the same data
point three times and select the different aggregation types.
8. In addition, a special Trend Enable data point can be selected. If configured, the trend
log will only log data, if the value of this data point evaluates true, i.e., is not zero. Click
the button to select a data point.
10. When done with the data point setup, click Save Changes to leave the dialog.
Tip! A shortcut to creating a trend log object and attaching a data point is to select a data point
in the data point manager, right-click on it and choose Trend Datapoint from the context
menu. This generates a trend log and links that data point to it.
Note, that the behavior of the trigger data point is influenced by the COV properties of the
data point. If the Only notify on COV property is checked, the data point triggers only if its
value changes to the value of the trigger condition. If that property is not checked, the data
point triggers on every write with a value that matches the trigger condition.
Note: Of course, you can also change directly to the Triggers tab when creating a trend object.
7. In the Manage Trigger Conditions you can refine the trigger condition depending on
the trigger data point class.
8. When done with the data point setup, click Save Changes to leave the dialog.
Where TrendLogName is the data point name of the trend (Trend Name). The UID is the
unique ID of the trend log object. The UID can be obtained from the ID column in the data
point list of trend log data points as shown in Figure 62. This would result in the trend CSV
file ‘/data/trend/out_temp_107C.csv’.
Because the contents are generated on-the-fly, the file size in the FTP client will appear as 0
Bytes. The decimal point and CSV column separator can be configured in the system
configuration of the Web UI. Note, that for a comma “,” as the separator, the decimal point
is a point. This is useful for English/U.S. applications. For countries that use the comma as
the decimal point, select the semicolon as the CSV separator.
For setting up e-mails, the account information has to be configured on the device, e.g., on
the Web UI. Then an e-mail template can be created and the trend object attached as a trigger.
4. In the Mail Triggers list, the added trigger data point appears with the Fill Level
condition.
6. Select the trend log CSV file of the trend object in the Attach File drop-down box and
click Add.
Note: ZIP versions of the CSV files are also available. Select those to save transmission bandwidth
and mailbox space.
1. Execute a network scan, as described earlier in this document. The scan folder is filled
with available schedulers.
2. From the data points in the import folder, select the scheduler objects you are interested
in and click the Use on Device speed button. This creates suitable remote schedulers
and the corresponding calendar objects in the Remote Devices folder.
3. Adjust the basic settings for the newly created objects, such as the object name and
description. The object name will be used as the name for the scheduler, as seen on the
Web UI.
Note: Due to the static input NV, which is required for a remote CEA-709 scheduler object, adding
remote scheduler points will change the static interface of the device.
The new static input NV representing the remote calendar on the local device (this NV is
normally called nviCalLink) needs to be bound to the output NV called nvoCalLink located
in the Calendar functional block of the remote device and the new static nviSchedLink NVs
which were created for each remote scheduler point need to be bound to the respective
nvoSchedLink variable located in the Scheduler functional block of the remote device. The
binding between the nvoSchedLink variable on the remote device to the nviSchedLink
variable on the local device defines which of the scheduler data points on the local device
connect to which scheduler unit on the remote device. All required information is transmitted
over the link NVs, so it is possible to later change the binding to any other remote scheduler
without rescanning the network.
Note: If connected via LNS, the bindings to the nvoCalLink and nvoSchedLink NVs are made
automatically by the configuration software in the download process.
1. Execute a network scan, as described earlier in this document. The scan folder is filled
with available remote alarm servers.
2. From the points in the import folder, select the alarm server points you are interested in
and click the Use on Device speed button. This creates the corresponding alarm
client points in your project.
3. In the CEA-709 technology select the new alarm client point and adjust the name of the
local NV (default name is nviAlarm_2). This NV is located in the Clients functional
block.
4. In the CEA 709 technology a static NV is created to receive information from the remote
device about changes to the scheduler configuration, so that the local device does not
need to poll the remote device. Set a name for this NV (default is
nviSchedLink<number>) and assign it to a suitable function block.
Note: Due to the static input NV which is required for a CEA-709 alarm client point, adding alarm
clients will change the static interface of the device.
The new static input NVs representing the alarm clients on the local device need to be bound
to the alarm outputs of the remote device. A CEA-709 device normally delivers alarms
through an output NV of type SNVT_alarm_2 located in the node object of the device,
therefore the new input NV on the local device must be bound to the alarm output NV of the
remote devices node object. All required information is transmitted over the alarm input NV,
so it is possible to later bind the alarm client to any other alarm server without rescanning the
network.
Note: If connected via LNS, the binding to the nvoAlarm2 NV is made automatically by the
configuration software in the download process.
1. Execute a network scan, as described earlier in this document. The scan folder is filled
with available trend logs.
2. From the data points in the import folder, select the trend log objects you are interested
in and click the Use on Device speed button. This creates suitable remote trend logs
1. Under the Global Objects folder, select the Math Object sub-folder.
2. Right-click and select New Math Object … from the context menu.
3. In the Create New Math Object dialog, enter a name and optionally a description for the
math object.
5. In the data point selector dialog, select the input data points and click OK. The data
points appear as v1, v2, etc.
Tip! A math object can also be created by multi-selecting data points in the data point manager
and right-clicking on them. Then choose Create Math Object … from the context menu. This
opens the dialog and attaches the selected data points as input variables.
6. If the data point shall trigger the math calculation only after a certain change-of-value,
enter a value into the COV delta column. If the data point shall never trigger the math
calculation, de-select the Triggers Calculation check box.
7. Select the input data point and click Add Variable to push the variable on the evaluation
stack.
8. Select a function to be applied on the variables and click the Add Function button.
9. Te resulting formula is displayed at the bottom of the dialog. Alternatively, the formula
can be entered there.
Note: When the formula entered at the bottom is still incomplete and does not yield a meaningful
command sequence, the list showing the RPN equivalent will be empty. This allows the user
to immediately see if the current input is valid or not.
10. Add output data points by clicking the Add Output DP button.
11. In the data point selector dialog select the output data points and click OK.
1. Under the Global Objects folder, select the Math Object sub-folder.
3. Right-click and select Configure Math Object … from the context menu.
5. To replace an input data point by another input data point without re-writing the entire
formula, click the Replace Input DP … button. This opens a data point selector dialog.
Select the replacement data point there.
6. To detach an input data point, click the Detach Input DP button. This leaves the
respective variable slot empty.
1. Select one or more data points that shall serve as the base data points.
2. Right-click and select the Configure Historic Filters … item in the context menu. As
an alternative, click on of the Historic Filter data point property.
3. The dialog Select Historic Filter opens. Click on to create a new one.
4. In the Create Historic Filter dialog enter a name and optionally a description.
5. To add a new filter function to the list click on the add button . Enter a filter entry
Name and choose the desired period Type. The name will appear with the historic filter
relation and helps identifying it. Depending on the type define the arguments Day and
Time. Select how many samples ago the filter goes back. The most current sample is
‘0’, the previous one is ‘1’.
6. To duplicate an entry click on the duplicate button . On the duplicate modify the
settings accordingly.
7. For getting the difference of an historic value to the current value check the box Delta
to current.
8. Click on Save Changes and select the created filter template. For each filter entry
defined, a historicFilter property relation is created under the base data point(s).
1. Select one ore more data points with historic filters that shall be removed.
2. On the data point property Historic Filter of Data Point click on the remove button.
Select the menu Tools Manage Historic Filters … to open the resource manager dialog.
Select a filter type and click the edit button for modifying it. Use the plus button to add
new filters and the minus button to delete selected filters. Click the duplicate button to
create a duplicate of the selected filter. Click the import button to load historic filters from
disk. When importing, filter definitions of the same name are overwritten. Click the export
button to store current filters to disk.
Data points are identified by a key column, which can be the data point’s unique ID (UID)
or full path (IdPath). If a matching data point is found for a line in the CSV file, the columns
are applied to its properties. If none of the key columns are present in an imported CSV file,
data points are created using the specified properties. For a batch edit, the key columns have
to be left in the CSV file, and only columns should be modified. For a full reference of the
CSV file format refer to Section 17.1.
2. Right-click and choose Export Data Point CSV … from the context menu.
3. The Data Point CSV Export dialog opens as shown in Figure 63.
4. Select a pre-defined set of data point properties that shall be exported as columns of the
CSV file.
5. If this set does not reflect the desired properties, edit the property set. Select one or more
properties in the Property list and click on minus to remove them from the list, or click
on plus to add more properties.
6. When finished modifying the property set, click on the save button to store the
property set for later use. To open a stored property set, click on the load button . This
property set is then available in the drop-down list.
8. Select Write values of child data points if the exported CSV shall also contain all child
data points of structures.
9. Finally click the button Write CSV to generate the CSV file. This file is now ready to
be edited in an external tool.
2. Right-click and choose Import Data Point CSV … from the context menu.
3. Choose a CSV file to be imported. The Configurator opens that file and applies the
properties to the existing data points. When finished a report is shown as depicted in
Figure 64.
To create data points from the CSV, remove the key columns from the exported CSV file or
export the CSV without these columns. Then follow the import steps of Section 4.13.1. Data
points from a certain #target section are filtered, if the selected source path does not match
the specified target technology. When importing from the device folder, all technologies are
imported, respectively.
Creating data points from data point template works like copy/paste of data points from an
existing configuration to a new one. The “copied” data point is just stored in a data point
template file (.dptmpl), which can be later “pasted”. For a given set of frequently used data
points of a given technology, the user can build a library of such template files.
Data point templates include the following properties of their original data point:
2. Right-click and select Create Data Point Template … from the context menu.
2. Right-click and select Apply Data Point Template … from the context menu.
3. Choose a ‘.dptmpl’ file. This will re-model the data points to the selected template.
1. Create a data point template CSV file. An example is shown in Figure 41. The referenced
‘.dptmpl’ files must be located in the same directory as the CSV file. The path to the data
point must be specified using the dot ‘.’ as the folder separator.
2. Select the menu Tools Import Data Point Template CSV … and choose the created
CSV file.
3. The temperature registers in the example are specified as trended. If the device model
supports different trend technologies, the import will prompt to choose one.
4. The import creates two temperature analog registers and two binary registers with alarm
conditions. The data point templates refer to an alarm server, which is also created, if
none exists with the same name.
The L-WEB software uses the standardized OPC XML-DA Web service to communicate
between L-WEB and remote LOYTEC devices, which makes it extremely firewall-friendly
and easy to setup.
The graphical design of the L-WEB user interface consists of pages, which can simply be
created by using the L-VIS/L-WEB Configurator software without any know-how in HTML,
Java, etc. Dynamic information is shown in the form of numeric values, text, changing icons,
bar graphs, trend logs, alarm and event lists, or schedule controls.
The complete set of automation functions of the data server is fully supported by L-WEB.
The automation services are residing in the embedded devices and are distributed over the
network to build up a dependable system with L-WEB only accessing these services.
Furthermore, any kind of calculations, data point connections, etc., are implemented on the
embedded Automation Server, which makes the application on the Automation Server
completely independent from the connection to the L-WEB application.
Starting from the data point configuration, the user can create an L-WEB project. The L-WEB
project contains the data point configuration of the Web service interface and a graphical
design for the L-WEB user interface. For more information on creating graphical designs
using the L-VIS/L-WEB Configurator software refer to the L-VIS User Manual [6].
1. Start the Configurator software and change to the L-WEB Projects tab.
3. Click Edit.
4. This opens the L-VIS graphical design tool. Complete the graphical design in the tool
and click the Write Project to Device speed button
Note: If the Configurator had been connected to the device, the graphical design would have been
added to the device in the same step.
3. Click Detect Projects on Device. This scans for all projects found on the device.
Projects marked as a green Yes in the In LINX Project column are L-WEB projects,
which are part of the current L-INX configuration project. Projects marked as a green
Yes in the On Device column are L-WEB projects, which are also stored on the device.
A red No identifies the L-WEB project to be missing in the project or on the device,
respectively.
4. If you want to download an L-WEB project to the device, which is missing there, select
the project and click Download. After the download the project appears with a green
Yes in On Device.
5. If you want to remove a project from the device, click Remove in the LINX Device box.
6. If you want to remove the project from the current L-INX project file, click Remove in
the L-WEB Projects on PC box.
7. If you want to export the L-WEB project into a separate L-WEB project file, click
Export… and select a file name in the file requestor dialog.
8. If you want to import an L-WEB project from a separate L-WEB project file, click
Import… and select the file in the file requestor dialog. The L-WEB project appears in
the project but not on the device.
4.15 I/Os
The L-IOB and LROC-40x models are equipped with local Inputs and Outputs to directly
connect to sensors and actuators. Additionally, a LIOB-48x/58x device can be extended with
the I/Os of one LIOB-45x/55x device. The following sections describe how to configure these
I/Os.
2. In the LIOB Configuration tree on the left, select the LIOB (LIOB-Connect), LIOB-FT,
or LIOB-IP bus.
4. In the file requestor, select a LIOB device template for your L-IOB model, e.g.,
liob100.xml. The L-IOB device appears in the LIOB Devices list.
5. Optionally, double-click on the Device name and enter a descriptive device name, e.g.
‘MyLIOB’.
6. To add more L-IOB devices repeat the add device step. Use the Up and Down button to
organize the L-IOB devices in the order as they are connected to the L-IOB host. Station
1 is the first L-IOB, station 2 the second, and so on.
7. Observe that the Device parameters table (below the LIOB device table) lists all device
configuration properties and also life values that can be exposed as L-IOB data points.
These L-IOB data points in turn can be exposed as OPC data points as well as input
and/or output data points in the logic program. By default, no device data points are
created. Using the checkboxes in the DP Create column of the Device parameters table,
device configuration properties and life values can be exposed as L-IOB data points.
Using the checkboxes in the OPC, PLC In, and PLC Out columns, it is possible to
select which of the created data points shall be exposed as OPC data points, logic
program input data points, and logic program output data points.
1. In the LIOB Devices list, select a configured L-IOB device or use multi-select to select
multiple devices at a time.
2. Click on the Duplicate Device(s) button . This duplicates the selected L-IOB devices
and all I/O configurations.
3. Unneeded devices may be deleted again by clicking the Delete Device(s) button .
4. To export a new template for a L-IOB configuration click the Export device template
button . No multi-select is possible for this operation. In the file save dialog, enter a
new L-IOB template file name and store it. This file can then be used in a different
project using the Add Device(s) button .
To Configure I/Os
2. The L-IOB tab displays the I/Os available on the device in the Inputs / Outputs list.
3. To adapt the I/O name, double-click the name in the Name column and edit it, e.g.,
‘RoomTemp’.
4. Select (or multi-select) an I/O in the Inputs/Outputs list and observe the Object
parameters list below. These parameters can be used to configure the I/O.
6. Note that the object configuration properties may change when changing the signal type
or interpretation. For detailed information on available configuration properties and their
dependencies refer to Section 3.5. In this example you may now edit the Interpretation
to ‘NTC10K’, which will allow connecting an NTC temperature sensor to the input.
7. Observe that the Object parameters table lists all I/O configuration properties and also
life values that can be exposed as L-IOB data points. These L-IOB data points in turn
can be exposed as OPC data points (LIOB-48x/58x) as well as input and/or output data
points in the logic program. Only the basic data points of each I/O (input, output,
feedback) are created by default. Using the checkboxes in the DP Create column of the
Objects parameters table, additional configuration properties and life values can be
exposed as L-IOB data points. Using the checkboxes in the OPC, PLC In, and PLC
Out columns, it is possible to select which of the created data points shall be exposed as
OPC data points, logic program input data points, and logic program output data points.
8. Analog inputs can be configured to be interpreted as digital by setting the check box
Digital Input. When using this option, configure the parameters OnValue and
OffValue. These define a hysteresis when tracking the analog value: If the digital value
is off, the analog value needs to go over OnValue to turn it on. If the digital value is on,
the analog value needs to drop below OffValue to turn it off.
9. For LIOB-58x devices, native BACnet objects (see Section 3.7.7) can be created using
the BACnet Object checkbox. For inputs with interpretation “Pulse Count”, it is
possible to choose between the BACnet Object Type “Analog Input” and
“Accumulator”. The corresponding data points will appear in the LIOB-58X / BACnet
Port / Datapoints folder of the Datapoints tab. The BACnet server object names and
descriptions will initially receive unique I/O names as described in Section 3.7.7. They
can be set to the current I/O names and descriptions by using the button Set BACnet
Names .
10. I/Os of the same hardware type can be copied using the Copy selected object and
Paste to selected object(s) buttons.
2. To export a new template for a L-IOB configuration click the Export device template
button . In the file save dialog, enter a new L-IOB template file name and store it.
This file can then be used in a different project using the Import Template button .
3. Existing configurations can be updated with new L-IOB templates by using the Upgrade
Template button . This can be used e.g. to migrate new functions which were not yet
available in earlier template versions. It is highly recommended to backup the original
project before upgrading templates. After upgrading the template, a log is displayed,
which shows all information about the upgrade process. Please carefully review this log
before using the updated configuration.
5. These terminal configurations can also be used to configure all I/Os of the L-IOB device
using a CSV file (see Section 17.3). The CSV file can finally be imported using the
Import terminal configuration button .
6. It is also possible to export such a terminal configuration from an existing project using
the Export terminal configuration button . After choosing a file location and name,
the user will be asked if only customized objects shall be exported. If this option is
enabled, only L-IOB devices with custom I/Os (where changes have been made) will be
exported.
7. To setup translation tables for certain I/O interpretation modes, click the Edit
translation tables button .
8. You can add and delete tables using the buttons Add table and Delete table. The data
types for the xin and xout columns of the table can be setup in Type In and Type Out.
In the Translation table entries list, you can enter the xin and xout values. The
translation is done (with linear interpolation) from measured xin values to yout values
which are used for the L-IOB data points. Further, the table values can be exported and
imported (CSV files) with Import Values and Export Values. Entire tables (including
table name and type) can be exported and imported with Import Table and Export
Table. Tables of some standard temperature sensors are installed with the Configurator
in the subfolder “LIOB\tables”.
Under this folder there exist sub-folders for each I/O on the controller. When selecting any
of the folders, the data point list shows all data points in the scope of that folder. The data
points on the Local IO / LIOB-IP folders provide general I/O data. The data points of the
I/O sub-folders expose the present value as well as status and configuration data specific to
the I/O. Refer to Section 3.5.3 for more information on I/O data points.
The I/O data points can be used in the configuration just as all other data points. To expose
an I/O directly as a variable to the PLC select the PLC check box. Note that I/O data points
cannot be directly subject to alarming. For doing so, native data points (CEA709) that support
alarm conditions must be created and put in a connection with the I/O data point.
1. Start the Configurator and open the LIOB-18x/48x/58x project to print labels for.
3. This opens the Print View dialog as shown in Figure 71. Select Export LIOB Labels
on the left side.
5. Click on Open to open the file in a separate PDF reader window. Click on Save to save
the PDF file.
6. Print the labels directly from the PDF reader embedded in the print view or from the
opened / saved PDF file.
4.15.7 Run-Hours
On digital inputs and outputs a run-hours data point can be configured that contains the
cumulative on-time of the I/O. This can be accomplished by the Elapsed_Active_Time
property of the native binary BACnet object for the I/O.
To Configure Run-Hours
3. Go to the BACnet object on the data points tab in the according LIOB folder of the
BACnet port.
4. In the context menu select Add/Remove BACnet Properties… and set the check box
in the Read column of the Elapsed_Active_Time property. If required expose the created
data point to OPC.
5 CEA-709
be unique per function block. Note, that once disabling this option, it cannot be enabled
anymore.
Enable Legacy Network Management Mode: This group box contains check boxes
for each CEA-709 port of the device. Put a check mark on the port, if this port shall be
operated in the legacy network management mode. In that mode, the port does not use
the extended command set (ECS) of network management commands. This can be
necessary to operate the device with some network management tools that do not support
the ECS.
Configure Domain: This section box contains self-configuration settings for the
CEA-709 ports, one for each channel. This is necessary if the device shall be used
without being commissioned by a network management tool. Set the check mark and
enter the CEA-709 domain and subnet/node information. If operated in self-configured
mode, the CEA-709 network can be scanned using the network scan (see Section 5.3.4)
and external NVs can be used on the device. Note, that the domain must match the nodes’
domain on the network and the subnet/node address must not be used by another device.
Important! Downloading the data point configuration after changing the interface, will result in a new
static interface! Thus, it is highly recommended to change this option only if connected via
LNS to allow the Configurator to update the LNS database accordingly!
If using a non-standard interface a XIF-File must be created to be able to add the device in a
network management tool (e.g. LonMaker) in case of an offline workflow (see Section
5.3.11).
The Constant Light Controller section (see Figure 76) allows enabling and disabling the
automatic bindings feature for each channel. See the L-DALI User Manual [3] for details on
the automatic internal binding algorithm.
Total number of date entries: Specifies the maximum number of date definitions which
may be stored by the calendar. This is the sum of all date definitions from all calendar
entries. A date definition is for example a single date, a date range, or a week and day
pattern.
Number of local schedulers: This is the number of local scheduler objects which should
be available on the device. Each local scheduler data point created in the data point
manager will connect to one of these scheduler objects. There may be more scheduler
objects available on the device than are actually used at a certain time. It is a good idea
to have some spare scheduler objects ready, in case another scheduler is needed.
Number of daily schedules: This is the maximum number of schedules supported by
each scheduler object. This number must at least be 7, since a scheduler always needs to
provide one schedule for each day of the week (default weekly schedule). For each
special day defined by the calendar or embedded exception day, an additional daily
schedule is required to support it.
Entries in Time/Value table: This is the total number of entries in each scheduler
defining a value template that should apply on a specific day starting at a specific time
(the time table).
Number of value templates: This is the maximum number of value templates supported
by each scheduler.
Data size per value template: This specifies the buffer size reserved to hold the data
for each value template. More data points or bigger data structures require a bigger value
buffer.
Max. number of data point maps: Specifies the maximum number of individual data
points that this scheduler is able to control.
AST Configuration Size: This number in Bytes is calculated from the scheduler settings
above and represents the total size of the LONMARK configuration properties file stored
on the device. While certain settings can be freely edited within the given limits, the
resulting configuration size is also limited.
As can be seen from the above list, it is not easy to configure a LONMARK scheduler object.
There are many technical parameters which need to be set and which require some knowledge
of how these scheduler objects work internally. Therefore, the configuration software
provides the following mechanisms to help in choosing the right settings:
Resources required by the current project: The absolute minimum settings required
by the current project are shown in a table at the left side of the window. This data may
be used to fill in the values at the right side, but some additional resources should be
planned to allow for configuration changes which need more resources.
Auto-Set: This button may be used to let the configuration software decide on the best
settings to use, based on the current project. Since the current projects resource usage is
taken as a starting point, all schedulers and calendar patterns in the project should first
be configured before this button is used.
Set Defaults: This button will choose standard values for all settings. In most cases,
these settings will provide more resources than necessary.
Note: On some models the CEA-709 AST resources are fixed and cannot be configured (e.g.
L-DALI models).
START
DONE
Start the Configurator software stand-alone and connect via the FTP method (see Section
4.4.1). Then restore the device configuration from the backup file, which has been created
when the original device has been configured or modified (see Section 4.4.6). After the
restore all data points, dynamic NVs and bindings, BACnet server objects and client
mappings are restored. The device is again configured online and fully functional in the
network.
If using an LNS-based tool, the device needs to be replaced in that tool at some later point in
time (see Section 5.2.3) as the NID has changed. If you are not using LNS, then refer to your
network management tool’s reference manual on how to replace a device.
1. In your LonMaker drawing, drag a device stencil into the drawing. Enter an appropriate
name as shown in Figure 79.
3. In the Device Template group box select a matching device template. For example select
“LINX-xxx_FT-10”, if a L-INX is configured to use the FT-10 interface, or
“LINX-xxx_IP-10L”, if a L-INX is configured to be on the IP channel. For information
on how to configure which port to use, refer to the Section “Port Configuration” of the
LOYTEC Device User Manual [1]. Note that for the LINX-15x the LINX-12x XIF has
to be used.
4. Select the channel, which the device is connected to and click Next.
6. Check Service Pin as the device identification method as shown in Figure 81 and click
Next.
7. Click Next in the following screens until you get to the final dialog shown in Figure 82.
10. Finally, you should get the device added to your drawing as depicted in Figure 83.
Channel FT-10
nvi01temp nvo00temp
nvi03lux nvo02lux
nvi05lev_percent nvo04lev_percent
nvi07temp_f nvo06temp_f
nvi09switch nvo08switch
nvi11motor_state nvo10motor_state
nvi13amp nvo12amp
nvi15fire_test nvo14fire_test
nvi17state nvo16state
nvi19temp nvo18temp
Gateway[0]
linx
Channel FT-10
6. Select the Service pin method and click on Finish as shown in Figure 88.
7. Then the service pin requestor opens as shown in Figure 89. Press the service pin on the
replacement device on the correct port. You can also send the service pin from the device
information page on the Web interface.
Figure 89: Wait for the service pin from the device.
8. After the service pin has been received, LonMaker commissions the replacement device,
creates the dynamic NVs again (if any), and installs the bindings.
the IP-852 port (e.g., LINX-10x_IP-10L.xif). For the LINX-15x model use the
LINX-12x XIF files.
LINX Configurator project file: This file contains all ports, data points, and connections
of a project. These files end with “.linx”, “.liob”, “.ldali”, or “.gtw”. It stores all relevant
configuration data and is intended to be saved on a PC to backup the device’s data point
configuration.
First, the device must be added to LNS (see Section 5.2.2). Then the LINX Configurator must
be started in plug-in mode to configure the device (see Section 5.3.1). In the Configurator,
scan for the data points in the LNS database (see Section 5.3.2). Select the data points that
the device shall expose (see Section 5.3.5). Finally, the configuration needs to be downloaded
to the device via LNS (see Section 5.3.9). It is recommended to backup the device
configuration to a file for being able to replace the device in the network (see Section 4.4.6).
START
DONE
To add more NVs when all bindings are in place and the device is already being used, simply
repeat the steps described above. The Configurator software will back up the bindings, create
or delete the dynamic NVs, and re-create the bindings again.
Start the Configurator in stand-alone mode and connect to the device via the FTP method
(see Section 4.4.1). If changing an existing configuration, upload the current configuration
from the device (see Section 4.4.2). In the Configurator, import data points from a CSV
import file (see Section 5.3.3) or from an XIF file (see Section 5.4.1). If the other devices are
already connected to the network you may also scan them online (see Section 5.3.4). Select
the data points that the device shall expose (see Section 5.3.5). Alternatively, you can create
external NVs manually (see Section 5.3.8). Finally, the configuration needs to be downloaded
to the device (see Section 4.4.4). It is recommended to backup the device configuration to a
file for being able to replace the device in the network (see Section 4.4.6).
START
Upload configuration
Section 4.4.2
Import network variables from XIF Import network variables from file Scan online for network variables
Section 5.4.1 Section 5.3.3 Section 5.3.2
DONE
Start the Configurator in stand-alone mode and connect to the device via the FTP method
(see Section 4.4.1). In the Configurator import data points from a CSV import file (see
Section 5.3.3) or from an XIF file (see Section 5.4.1). If the other devices are already
connected to the network you may also scan them (see Section 5.3.4). Select the data points
that the device shall expose (see Section 5.3.5). For the NVs used on the device select the
“static NV” allocation type (see Section 5.3.6). Alternatively, you can create static NVs
manually (see Section 5.3.7).
For network management tools, which do not support the ECS (enhanced command set)
network management commands, the legacy network management mode must be configured
(see Section 5.3.10). Please contact the tool’s vendor for information whether ECS is
supported or not.
Download the configuration onto the device (see Section 4.4.4). Finally, export a XIF file
(see Section 5.3.11). It is recommended to backup the device configuration to a file for being
able to replace the device in the network (see Section 4.4.6).
START
Import network variables from XIF Import network variables from file Scan online for network variables
Section 5.4.1 Section 5.3.3 Section 5.3.2
Tool supports
no
ECS ?
DONE
To use the device in the non-LNS management tool, commission the device using the
exported XIF file and create the bindings.
In NL220, the Plug-in is started by right clicking on the device node, then selecting the Option
LOYTEC LINX Configurator in the PlugIns sub menu.
In Alex, the Plug-in is started by right clicking on the device and selecting the LOYTEC
LINX Configurator in the Starte PlugIn sub menu.
2. Click on the button Scan channel. This scans in all NVs on all devices connected
to the CEA-709 channel of the device.
3. After the scan has completed, the folder LNS Database Scan is populated with the found
NVs. Data point names for those NVs are automatically generated, following the data
point naming rules defined in the project settings (see Section 4.3.2). By default the name
is generated from node name, object name, and NV name. These names are ensured to
be unique by adding a counter for multiple occurrences of the same name.
Figure 94 shows an example result of the database scan. The list can be sorted by each
column. Selecting a line will display a number of associated properties in the property view
below. Multiple items can be selected by using the <Ctrl> key and clicking with the mouse.
All items can be selected by pressing <Ctrl-A>.
3. Right-click and select Import File. In the following file selector dialog, choose the CSV
import file and click OK.
4. Now the CSV File folder is populated with the imported NVs as shown in Figure 95.
The list can be sorted by each column. Selecting a line will display a number of associated
properties in the property view below. Multiple items can be selected by using the <Ctrl>
key and clicking with the mouse. All items can be selected by pressing <Ctrl-A>.
3. Right-click on that folder and select Scan CEA709/852 Network…. This opens the
CEA709 Management dialog as shown in Figure 96.
4. If the device has not been installed with a network management tool (e.g. LNS-based
tool), press the Configure CEA709 Port button. This opens the device install dialog as
shown in Figure 97.
5. Select the Manually set domain check-box and click the Set button. This sets the device
configured, online to start the scan. Then click Close.
Note: You need to set the same domain as the devices to be scanned. Click Get Domain from
Network and press a service pin on some other, already installed device to retrieve the
domain information before setting the device online.
6. Click on the button Discover Devices. This starts a network scan. The results are put in
the device list box.
7. Alternatively, click the button Discover on Service Pin. Then press the service pin of a
particular device on the network. This device will be added to the device list.
8. Select a device in the device list. To give the device a usable name, enter the name in the
Device Name field and click on the Update Selected button.
9. Then click the button Scan. This scans the NVs on the selected device and adds them to
the CEA709/852 Network Scan folder as a separate sub-folder for the device as shown
in Figure 98.
Tip! If you are not sure which device you have selected, click on Wink. The selected device will
execute its wink sequence.
10. Click Close when all devices needed have been scanned.
1. Go to any of the CEA709 LNS Scan, CEA709 Network Scan, CEA709 CSV File, or the
CEA709 Devices from XIF folder.
2. Use the multi-select feature by holding the Shift or Ctrl keys pressed.
4. This creates data points in the CEA709 Port folder of the device. All data points in that
folder will actually be created on the device after downloading the configuration.
Tip! Data points can be edited by selecting a single point or using multi-select. The available
properties to be edited are displayed in the property view below.
1. In the data point view, select the NVs in the CEA709 port folder, for which the NV
allocation shall be changed.
2. Select the NV allocation property as indicated by the red rectangle in Figure 99.
3. To make the data points static NVs on the device, select Static NV in the Basic
Properties section.
2. Right-click in the data point list and select New Datapoint… in the context menu. This
opens the NV creation dialog as shown in Figure 100.
3. Enter a data point name and a programmatic name. The programmatic name is the name
of the static NV which is being created.
4. Select a resource file. To create a SNVT, let the STANDARD resource file be selected.
5. Select a SNVT and a direction. If a non-standard resource file has been selected, choose
from one of the UNVTs.
Tip! Recently created SNVTs are available in the Recent NV Types list. Click on one to set the
NV type without scrolling through the drop-down box.
6. The chosen SNVT implies a specific network unit. Compatible units for the metric (SI)
and U.S. systems are chosen. Adapt these to your needs.
8. Click Create Static NV. The static NV is created and appears in the data point list.
9. Note, that the static interface of the device will change as soon as static NVs are added
or modified in the data point manager. This change is reflected in a new model number,
which the device will receive after the configuration download (see Section 3.6.3). Also
note that the manually created static NVs are not bound automatically by the
Configurator. They simply appear on the device and need to be bound in the network
management tool.
2. Right-click in the data point list and select New Datapoint… in the context menu. This
opens the NV creation dialog.
4. Select the device in the box Select a Device on the left-hand side.
5. Enter the properties of the external NV on that device, starting with the local data point
name, the remote programmatic NV name, the NV type (SNVT) and direction. Note,
that the direction is the direction of the external NV on the device. Therefore, the remote
output NV nvo00_temp becomes an input on the device. Also enter the NV index in
decimal notation. This is the index under which the NV is found on the remote device.
Choose the preferred addressing mode, e.g., Subnet/Node.
7. The external NV now appears in the data point list. For external NVs, which are inputs
to the device, adapt the poll cycle property to your needs.
If the Configurator is connected to a CEA-709 device via LNS and the device uses static or
dynamic NVs, it can automatically generate Bindings in the LNS database. This behavior can
be influenced in the download dialog. The download process can also manage the device
template upgrade automatically in LNS, if the static interface changes (see Section 3.6.3).
To Download a Configuration
1. In the main connections window, click on the Download Configuration speed button
in the tool bar of the main connections window. This will open the configuration
download dialog as shown in Figure 33.
3. If the static NV interface has been changed, a new model number for the device needs
to be selected. This is necessary, as the static network interface of the device changes on
the CEA-709 network. The Configurator automatically selects a usable value, which can
be overridden in the field Model Number marked by the blue rectangle in Figure 33.
4. Click Start to start the download. Each of the actions is displayed in the Task List
section of the dialog. The current progress is indicated by the progress bar below.
5. When the download process has finished, a notification window appears, which has to
be acknowledged by clicking OK.
Note, that after the download is complete, the interface changes become active on the device
(i.e., the static NV interface has changed). Refresh the network management tool to
synchronize the tool with the changes to the LNS database made by the Configurator (e.g.,
use the menu “LonMaker|Refresh” in LonMaker or hit F5 in NL-220).
Normally, the Configurator software optimizes the download process by not executing
certain LNS operations, if not necessary. For example, only those bindings and dynamic NVs
are deleted and re-created, which correspond to real changes in the interface. The user can
check the Force Full Upgrade option to clean and re-do all steps.
4. Click OK.
1. Make sure the Model No will match the final model number of the port. If not, enter an
appropriate model number in the toolbar of the Datapoints tab.
3. Right-click on that folder and in the context menu select Build XIF ….
4. This opens a file requestor where the XIF file name needs to be entered. Select a useful
name to identify the device, e.g., as “LINX-10X_1.xif”.
2. Right-click and select Sync Dynamic NVs in the context menu. The Configurator then
loads any new dynamic NVs, which have been created but are not yet represented by
data points on the CEA-709 port. The process completes when the dialog shown in
Figure 103 appears.
3. Click on Finish. The new dynamic NVs now appear in the data point list and can be
edited and used on the device.
2. Right-click on the folder and select Create device(s) from XIF file… from the context
menu.
3. In the file open dialog select a XIF file to import and click Ok.
4. The imported data points appear as a device sub-folder of the CEA709 Devices from
XIF folder named after the XIF file name.
5. In that folder select those data points, which shall be used on the device and use them on
the device as described in Section 5.3.5.
6. Repeat the import of XIF files for as many nodes as needed. The same XIF can be
imported more than one time, resulting in multiple nodes of the same type in the
CEA709 Devices from XIF folder.
The imported devices must be assigned to actual devices on the network. This is done
by setting a node ID that corresponds to a node on the network.
The domain information must be written to the device and it must be set configured,
online to be ready for data communication.
To Install Devices
1. Open the CEA-709 management dialog by clicking on the Manage CEA-709 Devices
speed button.
2. If devices have been imported via a XIF file, they do not have a node ID (all zero). To
assign the physical node to the device, select the imported device.
3. Click the Update NodeID button and press the service button on the network node. The
node ID will be filled in to the selected device. Alternatively the node ID can also be
entered manually.
4. After node IDs have been assigned to all unassigned devices, select the device(s) to
install in the Device List of the CEA-709 management dialog. Multi-select of devices is
possible.
5. Click the Install button. This opens the Install Devices dialog as shown in Figure 104.
7. Enter the domain information or click Get Domain from Network and press a service
pin.
9. Some nodes won’t be operable on the new settings until they are reset. Click the Reset
button to reset the selected node.
10. Repeat this step for other unconfigured devices on the network.
Some nodes, however, do not possess such feedback NVs for certain functions. To support
getting feedback values on such nodes, the Configurator can create feedback data points
based on existing output data points. This is especially interesting for bound output NVs
(static and dynamic alike). The corresponding feedback data point is an input, which uses the
original output NV for polling the target NV. Once the binding is changed the new target is
polled. No additional input NV needs to be created for the feedback value, if the feedback
data point feature is used. Alternatively, the output data point can be switched to a value data
point with an integrated feedback function without the need for an extra feedback data point.
1. Select an output data point in the data point list of the CEA-709 Port folder, e.g.
‘nvoHumid101’.
3. A new input data point is created, having ‘_fb’ appended to the original name, e.g.,
‘nvoHumid101_fb’. Note, that the feedback data point maps to the same NV index as
the original output data point.
4. Choose an appropriate poll cycle in the data point properties for the feedback data point.
1. Select an output network variable in the data point list of the CEA-709 Port folder, e.g.
‘nvoHumid101’.
2. In the data point properties tab change the direction from ‘output’ to ‘value’.
3. Choose an appropriate poll cycle in the data point properties for the value data point.
The device supports both, the LONMARK file transfer and the simpler direct memory
read/write method. In both cases however, one has to keep in mind that a file transfer incurs
more overhead than a simple NV read/write. Therefore, polling CPs should be done at a much
slower rate than polling NVs (e.g., every 10 minutes).
Another aspect is how CPs are handled by network management tools. Formerly, those tools
were the only instance that could modify CPs in devices. Therefore, most tools do not
automatically read back CPs from the devices when browsing them. This can result in
inconsistencies between the actual CP contents on the device and their copy in the network
management tool. It is recommended to synchronize the CPs from the device into the LNS
database before editing and writing them back.
Important! For L-DALI devices it is highly recommended to start the Configurator as LNS Plug-In
when modifying and downloading parameters! In this case the Configurator will
automatically synchronize the CP values to the LNS database.
Note: Always choose Current device values or New Device Values for “Source of CP Values”
when commissioning or replacing a LOYTEC device!
2. Press the Upload button on the Configuration tab of the device properties (see Figure
105).
1. Right-click on a device object and select Commissioning Resync CPs… from the
context menu.
3. In this dialog select the radio button Upload values from device in the Operation group
box. To use the current settings of the device as default values for new devices, select
Set device template defaults from device.
Once the resource files are installed, the CEA-709 network scan and the LNS scan will
display the user-defined types from the resource files. Those data points can be used on the
device like regular, standard-type data points. Also manual creation of UNVTs can be
performed.
2. When the Create New NV dialog appears, change the resource file from ‘STANDARD’
in the Resource File drop-down box to the desired, user-defined resource file
3. Then select the desired UNVT from the Type drop-down list below. This list will display
the types of the selected resource file only.
1. Select the menu Tools Manage LonMark Objects … . The dialog Manage LonMark
Objects as shown in Figure 107 appears.
2. Edit the field Configurable Function Blocks to the number of needed function blocks.
3. Select a Type from the drop-down box for your function block. This drop-down box is
available at the top of a function block array. A change applies to the entire array.
4. To break up the pre-defined array, double-click on a name in the Name column and edit
it to something different. Typing the same name for consecutive function blocks will
create a new array.
5. To use an object type outside the scope of standard types, just type in the number instead
of choosing from the drop-down.
The example shown in Figure 108 illustrates such an incremental change. The first 9 NVs
stem from an older scan (already scanned) where the first 5 have actually been used on the
device (used check mark). The last scan resulted in the new items 10 to 12. When sorting the
Last Scan column it can be easily decided, which of the new NVs shall be used in the data
point configuration.
6 BACnet
Native L-IOB objects start with instance nr: This setting defines, which BACnet
object instance numbers shall be assigned to native L-IOB BACnet objects starting with
the defined instance number. This enables you to keep native BACnet objects for L-IOB
I/Os in a separate instance number range than regular BACnet objects.
For details on the L-DALI BACnet interface see the L-DALI User Manual [3].
START
Upload configuration
Section 4.4.2
DONE
Start the Configurator in stand-alone mode and connect to the device via the FTP method
(see Section 4.4.1). If changing an existing configuration, upload the current configuration
from the device (see Section 4.4.2). In the Configurator, start an on-line network scan to
discover devices and BACnet objects (see Section 6.3.1). Select the data points that the
device shall expose (see Section 6.3.3). Alternatively, you can create client mappings (see
Section 6.3.4) and local BACnet server objects (see Section 6.3.5) manually. Finally, the
configuration needs to be downloaded to the device (see Section 4.4.4). It is recommended
to backup the device configuration to a file for being able to replace the device in the network
(see Section 4.4.6).
START
DONE
Start the Configurator in stand-alone mode and select the appropriate device model in the
menu Model (see Section 4.4.1). In the Configurator, import external BACnet data points
from an EDE file (see Section 6.3.2). Select the data points that the device shall expose (see
Section 6.3.3). Alternatively, you can create client mappings (see Section 6.3.4) and local
BACnet server objects (see Section 6.3.5) manually. When finished store the configuration
on the hard drive and download later to the device (see Section 4.4.4).
3. Right-click on that folder and select Scan BACnet Network…. This opens the BACnet
Network Scan dialog as shown in Figure 113.
4. Click on the button Discover Devices. This starts a network scan. To narrow down the
scan range and reduce scanning time, enter a device ID range into the Scan from and to
fields. The results are put in the device list box. A progress bar below indicates how
many devices are being scanned.
5. Select a device in the device list and click the button Scan Objects. This scans the
BACnet objects on the selected device and adds them to the BACnet Network Scan
folder as a separate sub-folder for the device.
6. If the scan does not give the expected results, change the Device Scan Mode to normal
or slow and try again. With this setting the scanner uses simpler but slower protocol
features.
Note: If proprietary properties access on a remote device is required, support for proprietary
properties must be enabled in the BACnet tab of the Project Settings dialog (see Section 6.1).
1. Open the BACnet scan dialog as described above, select the desired BACnet device and
click on Scan Objects in order to re-scan objects on that device.
2. The resulting device folder in the BACnet Network Scan folder will be updated with
the new objects found on the BACnet device.
3. The last two columns Used on Device and Last Scan can be used to determine, which
objects are new and have yet been used on the device, as shown in Figure 114.
There are a set of EDE files. Select the main EDE file, e.g. device.csv. The EDE import will
also search for the other components, which must be named device-states.csv. Which
components are expected, please refer to the Chapter “Operating Interfaces” of the LOYTEC
Device User Manual [1]. Example EDE files can be found in the ‘examples’ directory of the
LOYTEC Configurator software installation directory.
3. Right-click and select Import File. In the following file selector dialog, choose the EDE
import file and click OK.
4. Now the BACnet EDE File folder is populated with the imported BACnet objects.
In an additional step, there can be also server objects allocated on the device. These server
objects can be created automatically from converting a client mapping to a server object. This
is usually done, if the imported BACnet objects shall also be directly modified over the
BACnet network on the device itself.
1. Open the data point manager dialog and select the desired BACnet objects in one of the
import folders.
2. Use the multi-select feature by holding the Shift or Ctrl keys pressed.
4. This creates data points in a remote device sub-folder of the BACnet Port/Datapoints
folder. All data points in that folder will be created as client mappings. No server object
is created automatically in this case.
5. To also create server objects select the data points in question using the multi-select
feature. Then activate the property Allocate Server Object in the section Advanced.
6. For editing the client mapping, you may multi-select client map data points and edit the
corresponding data point properties Client Confirmed COV, Client COV Expiry,
Client Map Type, Client Write Priority, Remote Instance Number.
2. Right-click in the data point list and select New Datapoint… in the context menu. This
opens the Create New BACnet Point dialog as shown in Figure 115.
4. Choose a target device in the list of known devices. Enter a Data Point Name, choose
an Object Type, and edit the target object instance number. Then select the Mapping
Type. For read client mappings edit the COV expiry or Pollcycle setting. If the read
type COV unsolicited is selected, the device listens for unsolicited COV broadcasts only
(and no COV subscribe or poling is performed). For write client maps edit the Write
Priority. For value client maps edit both. When finished click Create Client Mapping.
5. For an analog client mapping define a Network Unit. This is the engineering unit of the
remote object. Optionally, define a unit representation of the remote scalar value for the
metric (SI) and U.S. unit system on the device.
2. Right-click in the data point list and select New Datapoint… in the context menu. This
opens the Create New BACnet Point dialog as shown in Figure 116.
3. In the Mandatory Properties enter a Datapoint Name and an Object Type. Optionally,
update the Instance No and select the Commandable check box for value objects, if the
value object shall be commandable from the network.
4. In the Optional Properties you may select Unit SI and Unit U.S. for analog objects.
BACnet objects have no fixed network unit. Depending on the chosen unit system, the
analog BACnet object will be created with the specified metric (SI) or U.S. unit in the
engineering unit property.
5. For all object types you can enter the Description. The Device Type can be left empty.
For multi-state objects you have to select a multi-state map.
6. Click Create Server Object. The BACnet data point is created and appears in the data
point list.
2. Right-click and select Export EDE … in the context menu. This opens the EDE export
dialog to enter the EDE header information as shown in Figure 117.
4. Specify the Device Name and Device Instance. The device instance will be used by
other tools to configure their BACnet clients for accessing the exported device.
5. Optionally fill in project name, author to document that information in the EDE file.
6. Click Export.
There are a set of EDE files. Select the main EDE file, e.g. device.csv. The EDE import will
also search for the other components, which must be named device-states.csv. Which
components are expected, please refer to the Chapter “Operating Interfaces” for BACnet in
the LOYTEC Device User Manual [1].. Example EDE files can be found in the ‘examples’
directory of the LOYTEC Configurator software installation directory.
2. Right-click and select Import Server Objects from EDE…. In the following file
selector dialog, choose the EDE import file and click OK.
3. Now a folder for the device in the EDE file is generated and a report is displayed,
informing about the imported objects and possible reassignments.
2. Right-click on the data point and select Add/Remove BACnet properties … from the
context menu. The dialog appears as shown in Figure 118.
3. Check the additional properties. Checking the Read box will add an input data point,
checking the R/W box will add a value data point.
4. Click Close. The selected data point can now be expanded with the plus icon and show
its additional properties as sub-data points.
5. To remove properties perform the same steps and uncheck the corresponding check-
boxes. Alternatively, select the property (or more) and press the Delete key.
1. In the Configurator software menu go to Settings Project settings …. This opens the
Project Settings dialog (see also Section 6.1).
3. Put a check mark either on ASCII/UTF-8 (default), UCS-2 (Unicode, e.g., for
Japanese), or ISO-8859-1 (for Western European languages).
4. Click OK.
2. Right-click on the data point and select Add/Remove BACnet properties … from the
context menu. The dialog for mapping BACnet properties to data points appears.
2. Right-click on the data point and select Create Priority Feedback Point from the
context menu.
3. A new data point is created, which is a feedback client mapping that reads the active
priority out of the remote object.
To read back the value at a given priority slot, additional priority read input data points can
be added. They reflect the value at the configured priority slot between 1 and 16. If the
priority slot is NULL the data point stays at invalid value.
2. Right-click and select Create Priority Write Point… from the context menu.
3. A dialog prompts for the write priority. Note that the write priority can also be changed
later.
4. The new priority write data point appears below the original BACnet server object data
point.
2. Right-click and select Create Priority Read Point… from the context menu.
3. A dialog prompts for the read priority. Note that the read priority can also be changed
later.
4. The new priority read data point appears below the original BACnet server object data
point.
3. The Duplicate data points and set naming rules dialog opens as shown in Figure 119.
4. In the Data Point Assignment section choose to assign the duplicated data points to a
new BACnet device instance and click OK.
5. A new BACnet device folder is created with the duplicated client mapping data points.
The original BACnet device is also duplicated, leaving the actual device instance number
empty and marking the device to be commissioned later on the Web interface as
described in the LOYTEC Device User Manual [1].
6. The BACnet Device Manager shows the created devices as depicted in Figure 120.
7 M-Bus
7.1 Configurator
This section describes how to use the Configurator software for the management of M-Bus
data points. For further information on the Configurator software refer to Chapter 4.
2. In the Device Configuration tab enable the M-Bus check box on all desired ports.
Important: If the M-Bus Port is deactivated via the checkbox or a firmware or model version is chosen,
which does not support M-Bus, the complete M-Bus configuration is deleted. In this case
a dialog is displayed, which has to be confirmed.
Figure 121: Data Point Manager Dialog with M-Bus folder list
Figure 122: Datapoint Manager Dialog with M-Bus Data Point List.
o M-Bus: This folder contains a folder with data points for each created filter
template.
LINX-XXX: This is the device folder (see Section 4.2.1). For M-Bus an additional port
folder exists:
o M-Bus Port: This folder contains the remote M-Bus data points, which are
used on the device.
START
DONE
START
DONE
The automatic device name is concatenated from the device medium (e.g. Electricity), the 3
character M-Bus manufacturer code and the address. For example the device could be
automatically named “Electricity_LOY_7”. If a name is specified, the device name of the
applied device is concatenated the address, e.g., “Device_7”.
The automatic data point name is concatenated from the device name the data point is related
with and the type of the data point. For example if a data point is an energy counter value in
the device “Electricity_LOY_7”, the name “Electricity_LOY_7_Energy” is created.
The M-Bus scan can only scan for input data points. Output data points can be created
manually or imported via a device template.
2. Right click on the Folder M-Bus Network Scan and select Scan M-Bus Network. This
opens the M-Bus Management Dialog containing the scan options shown in Figure 125.
3. In M-Bus Transmission Settings choose the address scanning mode. The default is
secondary address scanning. This prevents problems with duplicate primary addresses
of previously uninstalled M-Bus devices.
4. On device models with multiple active M-Bus ports, select Auto to scan on all ports or
select a specific port.
Important: Selecting 300 Baud results in a very slow scan. Aborting the scan is possible using the
Abort Device Scan button
6. Start the scan by pressing the Start Device Scan button. The progress bar shows the
progress of the scan. Under the progress bar, a text displays, which device is currently
scanned. When a device is found, it is displayed in the device list. The name of the device
is automatically created as described in section 7.3.1.
7. The scan can be aborted by selecting the Abort Device Scan button.
8. When the device scan is finished (either aborted or ended), the devices can be selected
for a data scan. Also multi-select is possible.
9. Select the devices which have to be scanned for data points and press the Scan Device
Data button. This scans all data points of the selected devices. For every device a folder
with the name of the device is created under the M-Bus Network Scan folder. The data
points found are placed in the Datapoints folder of the appropriate devices.
3. Either press on the Use on Device button or right-click and select Use on Device.
The selected data points are now available in the Datapoints subfolder of the M-Bus
Port folder.
2. Select the desired data points, you wish to create a template from, also multi-select is
possible.
3. Right click on one of the selected data points and select Use as Template. This creates
a folder, containing the selected data points.
1. Right click on the folder M-Bus Network Scan and select either Use on device and
apply single M-Bus filter templates or select Use on device an apply all M-Bus filter
templates. When all filter templates are applied, all matching data points from the scan
are used on the M-Bus port of the device.
2. When Use on device and apply single M-Bus filter templates is selected, the following
dialog is opened:
3. The drop down box shows all available M-Bus filter templates. As additional
information, when a filter template is chosen, the number of data points is displayed,
which match the template.
The Network Management dialog shown in Figure 126 shows a list of devices. Devices
which have been scanned using a network scan have the status online, devices which have
been created manually or using device templates have the status offline. If a device which is
online also has been scanned for device data, a green checkmark is displayed in the Data
column.
in the tool bar of the Datapoints tab. The M-Bus Management dialog opens, showing
the Network Management tab displayed in Figure 126.
1. Fill in the Device Address and select a Device Baudrate from the drop down box. For
a device model that has multiple active M-Bus ports select the Port as well.
2. A Device Name can be specified. If more devices with the same properties have to be
created using subsequent addresses, the end address can be specified in the input field
on the right hand side of the Device Address field.
3. If the device shall be created without knowing the address of any physical device, leave
the above address fields empty (port at Auto) and select Commission later. This device
can then be commissioned on the Web UI as described in the LOYTEC Device User
Manual [1].
4. The device capabilities specify, what kind of M-Bus read requests the device is able to
process. If nothing is specified here, Default Read is used. For other options please refer
to Section 7.1.6.
5. The optional device information just represents manufacturer details and model details.
This information is used in two cases:
a. The device name is not specified – in this case a device name is automatically
created from the optional device information. The name is concatenated to
MAN_Medium_address, where MAN is the 3 character manufacturer code,
Medium is the M-Bus medium (e.g. “Heat”) and address is the specified
address.
b. Device templates can be created from the M-Bus devices. The device templates
store the device information in order to identify a device.
6. Click on the Create Device button. This creates the M-Bus device and adds it to the
device list on the left hand side of the dialog.
7. When a device is selected the device information is displayed in the appropriate fields
on the right hand side of the dialog. The information can be changed in the fields. Press
the Update Device button to store the changes.
8. If a device has to be deleted select the device and press the Remove Device button.
2. Press the Scan Device Information button. If the device is found in the network, the
device properties are filled.
3. Enter a name for the M-Bus device in the Device Name field. If no name is specified the
name is created automatically as described in section 7.3.1 from the M-Bus data the
device sends back.
4. Enter a device address in the Device Address field. If more devices with the same
properties have to be created using subsequent addresses, the end address can be
specified in the input field on the right hand side of the Device Address field.
5. If the device shall be created without knowing the address of any physical device, leave
the above address fields empty and select Commission later. This device can then be
commissioned on the Web UI as described in the LOYTEC Device User Manual [1].
1. Enter a name for the M-Bus device in the Device Name field. If no name is specified the
name is created automatically as described in section 7.3.1 from the M-Bus data the
device sends back.
2. Enter a device address in the Device Address field. If more devices with the same
properties have to be created using subsequent addresses the end address can be specified
in the input field on the right hand side of the Device Address field.
3. Click on the Create From Template button. This opens the Import M-Bus Device
Template dialog shown in Figure 127.
4. Press the button and select a template file from the Open dialog.
6. Press Import for importing the template or Cancel for closing the dialog without any
changes.
7. When a template is imported, a folder with the name of the device is created. Under this
folder a Datapoints folder containing the data points from the template file is created.
Tip: Data points can be added to the data points of the template by right-clicking in the data
point list and selecting New Datapoint.
When you want to create one or more device instance together with its data points, use the
button Create with DP instead of the button Create From Template. This creates the device
instance, all the data points from the template can be found in the M-Bus Port’s data points
folder.
2. Press the Remove Device button. If the device already has data points, these data points
have to be deleted before the remove can be performed.
2. Update the field Device Address or select another Baud rate in the combo box.
1. Select the Baud rate for the device scan. For more information on scanning the M-Bus
network refer to Section 7.3.2.
3. When the device scan is finished, the devices can be selected for a data scan. Also multi-
select is possible.
4. Select the devices which have to be scanned for data points and press the Scan Device
Data button. This scans all data points of the selected devices. For every device a folder
with the name of the device is created under the M-Bus Network Scan folder. The data
points found are placed in the Datapoints folder of the appropriate devices.
Important: If a device, which is scanned, is already in the device list, the existing device can either be
overwritten; deleting all previously scanned data points of the existing device or the
scanned device can be discarded. A dialog is displayed for this decision.
2. Right click in the data point list view and select New Datapoint in the context menu.
3. This opens the Create New M-Bus Datapoint dialog shown in Figure 128.
4. If the M-Bus device which provides the data point is not in the list, it has to be created.
In this case open the Network Management dialog by clicking the Edit M-Bus Devices
button.
5. Create the device in the Network Management dialog and close the dialog.
7. The data point properties are entered in the group Datapoint Properties as shown in
Figure 128.
8. Enter a data point name. If no name is entered, the data point is named as described in
section 7.3.1.
9. At the moment only analog M-Bus data points are supported. Select if the data point is
an analog input or output. For analog inputs no M-Bus data coding can be specified.
10. Select if the data point shall be specified by providing the numbers for Storage number,
tariff, subunit, function field and data coding or if the information configured using the
DIF/DIFE list.
For reference, if one piece of information is entered, the other one is derived from the
specified data. Enter the data point information.
If the DIF list is entered, the dialog expects hexadecimal numbers. As soon as the
information is entered the other fields are updated.
11. Enter the VIF/VIFE list. This list specifies the M-Bus counter type, and unit of the data
point. Also this field has to be specified using hexadecimal numbers.
12. Usually data points are added to a default poll group. If the data point has to be member
of another poll group than default, the poll group can be selected using the drop down
box.
In the drop down box the previously specified poll groups are shown. If no poll group is
configured only the default poll group is displayed. Refer to section 7.3.7 for more
information on poll groups.
13. The FIV list defines the network unit of the M-Bus data point. In addition you may
choose its representation in the selected unit system.
14. Press the Create button to create the M-Bus data point
Tip: After creating a data point, the poll group can be changed in the data points property view.
Also multi-select can be used.
1. Right click on the Folder M-Bus Device Templates and select Import device template
from the context menu.
2. This opens the Import M-Bus Device Template dialog shown in Figure 129.
3. Press the button and select a template file from the Open dialog.
5. Press Import for importing the template or Cancel for closing the dialog without any
changes.
6. When a template is imported, a folder with the name of the device is created. Under this
folder a Datapoints folder containing the data points from the template file is created.
Tip: Data points can be added to the data points of the template by right clicking in the data point
list and selecting New Datapoint.
Importing a device template from the folder list does not create a device instance. Device
instances can only be created using the import in the Network Management Dialog.
Using imported data points is a little different to the use of scanned data points. For a scanned
device a device instance already exists – the important information address and Baud rate –
devices imported from templates do not have an address or Baud rate.
3. Either press on the Use on Device button or right-click and select Use on Device.
This opens the M-Bus Configure Device For Use dialog shown in Figure 130.
4. The device list displays all devices which have the same Manufacturer ID, version
number and Medium. If no device instance matches the device template, create one by
entering the network management dialog. The dialog can be entered by pressing the Edit
M-Bus Devices button. In the management dialog, the device instance can be either
created manually (take care of entering the correct Manufacturer ID, Version and
Medium) or by simply importing the template again.
5. Select one or more device instances from the list and press the Use On Device button.
This creates for each selected data point and each selected device one data point in the
M-Bus Port’s data point list.
An M-Bus device template contains the following configuration items describing an M-Bus
device:
Structure types, multi-state maps, historic filters used by M-Bus data points,
in the tool bar of the Datapoints tab. This opens the Network Management dialog as
displayed in Figure 131.
2. The device list shows all devices of the current configuration. Select a device.
3. Press the Export Device Template button. This opens the M-Bus Export Template
dialog.
4. Press the button and select a template file from the Save dialog.
5. Enter the Creator, Company Name and Version for the template. This information is
stored in the template file, when importing the template file the information is displayed
after selecting the file.
1. Right-click on the folder of the device template that has to be exported or its data point
folder and select Export Device Template… from the context menu.
2. Proceed as described above to export the template in the Export M-Bus Device
Template dialog.
Time-based: The poll group is triggered on a time base. This means that after a
specific time – the poll cycle – the poll group is processed.
Trigger-based: The poll group is triggered on a special trigger data point. As soon
as the trigger condition is met, the poll group is processed.
Tip: If an M-Bus device is only able to process default read requests, it is advisable to attach all
data points of this device to the same poll group (this increases the performance).
The poll group a data point is attached to can be changed in the properties view of the data
points. The poll group can also be changed for multiple data points using multi-select.
in the tool bar of the Datapoints tab. The M-Bus Management dialog opens.
2. Open the Pollgroups tab. This shows the dialog displayed in Figure 132.
3. The default poll group is selected and its properties are displayed. Enter the name of the
new poll group and enter the poll cycle in seconds. Make sure that under Pollgroup
Mode Time-based is selected.
4. Press the Save button to store the poll group and continue editing.
5. If a poll group needs to be updated or deleted, select the poll group edit the data and
press the Update Selected or Delete Selected button.
6. Press the Close button to finish editing. When the poll groups have not been saved, a
dialog asks whether the changes have to be saved or not.
2. In the M-Bus Management dialog, open the Pollgroups tab. This displays the poll
groups management tab displayed in Figure 132.
3. Enter a new poll group name and select Trigger-based or Trigger-based with
synchronization.
5. Select the new poll group. This enables the Add… and Remove buttons from the
triggers.
6. Press the Add… button and select a trigger data point. This can for example be a binary
user register.
7. The selected trigger data point appears in the trigger list as shown:
8. Select the trigger from the list and check the desired trigger conditions.
3. Create a trend log as described in Section 4.9. Set the Trend Mode to Change of Value
(COV) and add all required data points.
The status on the right hand side of the dialog shows, if the device is connected or if the
protocol analyzer is stopped or started. When connected to a device, the protocol analyzer
can be started by pressing the Start Protocol button. This starts the protocol analyzer in the
device. Every time a transmission is made on the M-Bus port, the transmission is displayed
in the list. Additionally the protocol data is stored in the device in a rotating log file. The
protocol log can hold up to 40 kB of protocol data. So also when the Configurator was not
running for an interesting time, the protocol data can be loaded from the device using the
Load From Device button. The protocol data can be stored as CSV file using the Save
button, with the Clear button, the shown protocol is deleted.
Figure 134 shows a typical protocol analyzer output for the M-Bus port. It shows the
following information:
Seq.: sequence number, which is automatically created in the device. This number
is unique for one port.
Frame Type: M-Bus frame type (Short Frame, Control Frame Long Frame, E5 –
in this case, no other data follows).
Length1, Length2: Frame length according to the M-Bus standard (must be equal).
Payload: Payload in hexadecimal numbers (this column cannot be used for sorting).
Some frame types do not contain the full set of fields. Please refer to the M-Bus standard for
additional information.
2. Disconnect the device which has to be replaced from the M-Bus and connect the new
device to the network.
3. Start the M-Bus device scan (see Section 7.3.2). The new device may produce a primary
address conflict. This conflict may either be resolved automatically after the scan or
manually during device replacement.
in the tool bar of the Datapoints tab. The M-Bus Management dialog opens, showing
the Network Management tab displayed in Figure 126.
5. Select the device which has to be replaced and press the Replace Device button. This
opens the dialog displayed in Figure 135.
6. In the replacement dialog all compatible devices for replacement are shown. If the
required device is not shown in the list, remove the check Only show exact match. This
will show all possible devices. Note, that only M-Bus devices can be selected as a
replacement device, which do are not yet using data points on the device.
8. If the selected replacement device is still in conflict, the Configurator will suggest to
automatically update the primary address to that of the replaced device.
8 Modbus
8.1 Configurator
This section describes how to use the Configurator software for the management of Modbus
data points. For further information on the Configurator software refer to Chapter 4.
2. In the Device Config tab enable the Modbus check boxes on the desired ports as shown
in Figure 136. Setting the check box enables Modbus on that port. Edit the Modbus
communication settings.
3. If slave mode is enabled, you may change the default Modbus register layout in the
Modbus Slave Register Configuration box.
Important: If the Modbus port is deactivated via the checkbox or a firmware or model version is
chosen, which does not support Modbus, the entire Modbus configuration is deleted. In
this case a dialog is displayed, which has to be confirmed.
Figure 137: Data Point Manager Dialog with Modbus folder list.
Figure 138: Datapoint Manager Dialog with Modbus Data Point List.
can be added to the folder. Additionally suitable data objects can be created for
the use on the device by selecting the Use on Device option.
LINX-XXX: This is the device folder (see Section 4.2.1). For Modbus additional port
sub-folders exist:
o Modbus Port RS-485: This folder contains the remote Modbus data points of
the Modbus RS-485 port, which are used on the device.
o Modbus Port TCP: This folder contains the remote Modbus data points of the
Modbus TCP port, which are used on the device.
manually. If devices are online, an online test feature can help in identifying Modbus registers
and their settings.
Figure 139 describes the workflow for setting up a Modbus network. For using Modbus the
Modbus ports of the LOYTEC device and the Modbus devices have to be configured. The
RS-485 Modbus port must get a Baud rate, the parity is fixed at none and the stop bits are
configured to 2. The Modbus TCP port must get the TCP port number of the slave devices
The Modbus devices have to be configured according to the LOYTEC device’s port
configuration (see Section 8.2.1). When no device template is available for a Modbus device,
this template can be created by manually configuring Modbus data points for the device (see
Section 8.2.2). If the Modbus device is already online, data points can be created using the
online test feature by scanning register values out of the device (see Section 8.2.3). In both
cases the created data points can be exported as a device template. The exported device
template can then be used to easily add additional Modbus devices with the same data point
configuration (see Section 8.2.4). Also mixing the two methods is possible. When using the
device templates also data points can be added manually. The configuration is then
downloaded to the device and the device is rebooted (see Section 4.4.4).
START
Configure Modbus Data Points manually Modbus Data Points with Online Test Import Modbus Device Templates
Section 8.2.2 Section 8.2.3 Section 8.2.4
DONE
The Modbus Management dialog shown in Figure 140 shows the list of devices. Devices
which have been imported from a template show the template name in the last column. For
each device the address, the IP address (if available), the port and the number of data points
available on that device is shown.
The Modbus Management dialog can also be used for the configuration of poll groups and
for accessing the LOYTEC devices protocol analyzer.
in the tool bar of the Datapoints tab. The Modbus Management dialog opens, showing
the Modbus Device Management tab displayed in Figure 140.
1. Fill in the Device Address and select the Type (either RS-485 or TCP) from the drop
down box. If the device has more than one RS-485 port, select the appropriate Port.
2. A Device Name can be specified. If no device name is specified, the device name is
created automatically. If more devices with the same properties have to be created using
subsequent addresses, the number of devices can be specified in the input field under the
Device IP Address field. If a number of TCP devices has to be created, subsequent IP
addresses are configured. If the checkbox Increase Device Address is checked, also the
Device Addresses (unit IDs) of the TCP devices are increased.
3. The Device Address specifies the address of the Modbus device ranging from 1 to 255.
In case of a TCP device the device address specifies the unit ID. For a RS-485 device
the device address has to be unique, TCP devices can have equal device addresses.
5. If the device shall be created without knowing the address of any physical device, leave
the above address fields empty and select Commission later. This device can then be
commissioned on the Web UI as described in the LOYTEC Device User Manual [1].
6. If the device is not able to read adjacent registers with one read command, activate the
checkbox Single Read. If the device is not able to process writes of multiple registers in
one command, activate the checkbox Single Write.
7. The setting Multiple read limit allows limiting the number of registers in a multi-read
request. The default is disabled. Set this value, if a Modbus device has problems with
the default multi-read. The same concept applies to limiting the read of multiple Coil
and Discrete Input registers using the Multiple bit read limit.
8. The Device timeout specifies how long a device may take to reply. After this timeout,
the device is assumed offline. When left empty it defaults to 800ms.
9. If the Configurator is connected to a LOYTEC device, the Test button can be used to
verify the device settings by checking whether the respective Modbus device can be
contacted.
10. The optional manufacturer details just represent Manufacturer name and Model name.
This information is used to identify device templates.
11. Click on the Create Device button. This creates the Modbus device and adds it to the
device list on the left hand side of the dialog.
12. When a device is selected the device information is displayed in the appropriate fields
on the right hand side of the dialog. The information can be changed in the fields. Press
the Update Device button to store the changes.
13. If a device has to be deleted select the device and press the Remove Device button.
1. Enter a name for the Modbus device in the Device Name field. If no name is specified
the name is created automatically from the name in the template file.
2. Fill in the Device Address and select the Type (either RS485 or TCP) from the drop
down box. If TCP is selected also enter the Device IP Address. If more devices with the
same properties have to be created using subsequent addresses, the number of devices
can be specified in the input field under the Device IP Address field.
3. Click on the Create From Template button. This opens the Import Modbus Device
Template dialog shown in Figure 141.
4. Press the button and select a template file from the Open dialog.
6. Press Import for importing the template or Cancel for closing the dialog without any
changes.
7. When a template is imported, a folder with the name of the device is created. Under this
folder a Datapoints folder containing the data points from the template file is created.
Tip: Data points can be added to the data points of the template by right-clicking in the data
point list and selecting New Datapoint.
1. Enter a name for the Modbus device in the Device Name field. If no name is specified
the name is created automatically from the name in the template file.
2. Fill in the Device Address and select the Type (either RS-485 or TCP) from the drop
down box. If TCP is selected also enter the Device IP Address. If more devices with the
same properties have to be created using subsequent addresses, the number of devices
can be specified in the input field under the Device IP Address field.
3. Click on the Create with DP button. This opens the Import Modbus Device Template
dialog shown in Figure 141.
4. Press the button and select a template file from the Open dialog.
6. Press Import for importing the template or Cancel for closing the dialog without any
changes.
7. When a template is imported, a folder with the name of the device is created. Under this
folder a Datapoints folder containing the data points from the template file is created.
8. The created device is shown in the list together with the number of data points.
2. Press the Remove Device button. If the device already has data points, these data points
have to be deleted before the remove can be performed.
4. When the device type is changed, it is verified that no device with the address exists on
the appropriate port – on RS485 the device address has to be unique, on TCP the device
IP address has to be unique.
2. Right-click in the data point list view and select New Datapoint… in the context menu.
3. This opens the Create New Modbus Datapoint dialog showing only the devices which
are available on the appropriate port. This dialog is shown in Figure 142.
4. If the Modbus device which provides the data point is not in the list, it has to be created.
In this case open the Modbus management dialog by clicking the Edit Modbus Devices
button.
5. Create the device in the Modbus Management dialog and close the dialog.
7. Enter the General Data Point Properties. These are the data point name, which is
automatically created when not specified, and the Register Type. The register type of
the data point is provided in the Modbus device documentation. The drop down menu
shows the Modbus register type, the direction (read and write) and the function code.
The data point properties are entered in the presented section of the dialog.
8. Enter the properties of the data point. The register address is specified by the
manufacturer. Select the Modbus Data Type. This type specifies how the manufacturer
stores data in the Modbus device. The Modbus Data Length is automatically updated
according to the data type. Offset, Multiplier and Exponent can be used for mapping
purposes. The Value of the data point is calculated as follows:
Modbus does not specify any byte orders of the data stored in devices. For some devices
it may be necessary to change the byte order. This is done by the check boxes Swap 16
bit, Swap 32 bit and Swap 64 bit. When Swap 16 bit is activated, the 2 byte of a word
are swapped, when Swap 32 bit is activated, the 2 words of a 32 bit value are swapped
and if Swap 64 bit is activated, the two 32 bit words of a 64 bit value are swapped. A
preview of the byte order is shown under the check boxes.
Select the Data Point Type of the data point (analog value, multi-state or binary) – only
the types which are available for the register type-data type combination are shown.
9. For an analog Modbus Master data point define a Network Unit. This is the unit of the
register on the Modbus device. Optionally, define a unit representation of that remote
register value for the metric (SI) and U.S. unit system.
10. Select a poll group for read data points from the Pollgroup drop down box. The drop
down box is grayed out for write registers. Additional poll groups can be configured in
the Modbus Management dialog.
11. In order to create a series of data points in one swoop, enter the Number of data points
to be created.
12. Press the Create button to create the Modbus data points. The register indices will be
adapted in ascending order. If data points should already exist at any of those indices,
they are skipped.
13. After the point is created the dialog is not closed, so additional data points can be created.
Tip: After creating a data point, the poll group can be changed in the data points property view.
Also multi-select can be used in the data point property view.
3. In the Modbus Device List select the Modbus device, which is online and shall be read.
A Modbus device with a pre-configured address fills in the Address (IP-Address if on
Modbus TCP) and Port fields. For a commission-later device, the current address
information can be retrieved from the connected LOYTEC device by clicking the read
slave address button .
4. Enter a data point name and select the Modbus Register Type in the General Datapoint
Properties group box.
5. In the Register Properties group box select the Modbus Data Type, scaling and swap
setting as assumed.
6. In the Online Register Test area enter the Read Start Address and Number of
Modbus Registers to read. Note, that a Modbus register is always 2 Bytes long.
8. The data read from the Modbus device is displayed in the Read raw data box as hex
bytes and in the Value list box as interpreted data.
9. Adapt the value interpretation in the Register Properties area until the expected result
appears. The results are immediately visible.
10. You may enable the Read continuously option, which periodically reads the registers
and displays them in the value list. You may use this option to monitor register values
and particular registers of interest.
11. Select the register values in the Value list. You may also use multi-select.
12. Click Create Data Point. This creates data points that will provide the selected register
values.
2. Right-click and choose Test Selected Data Points from the context menu.
3. The Data Point Values window opens and shows the read progress for the selected data
points. For each completed read a status result and a value is shown.
1. Right click on the Folder Modbus Device Templates and select Import device
template from the context menu.
2. This opens the Import Modbus Device Template dialog shown in Figure 143.
3. Press the button and select a template file from the Open dialog.
5. Press Import for importing the template or Cancel for closing the dialog without any
changes.
6. When a template is imported, a folder with the name of the device is created. Under this
folder a Datapoints folder containing the data points from the template file is created.
Tip: Data points can be added to the data points of the template by right clicking in the data point
list and selecting New Datapoint.
Importing a device template from the folder list does not create a device instance. Device
instances can only be created using the import in the Network Management Dialog. In this
dialog also the device instances can also be created with their data points.
3. Either press on the Use on Device button or right-click and select Use on Device.
This opens the Choose Modbus Device Instance dialog.
4. The device list displays all devices which have the same Manufacturer, and the same
Model Name as the template. If no device instance matches the device template, create
one by entering the Modbus management dialog. The dialog can be entered by pressing
the Edit Modbus Devices button. In the management dialog, the device instance can be
either created manually (take care of entering the correct manufacturer and model) or by
simply importing the template again.
5. Select one or more device instances from the list and press the Use On Device button.
This creates for each selected data point and each selected device one data point in the
Modbus Port’s data point list.
A Modbus device template contains the following configuration items describing a Modbus
device:
Structure types, multi-state maps, historic filters used by Modbus data points,
in the tool bar of the Datapoints tab. This opens the Network Management dialog
opens as described in Section 8.2.1.
2. The device list shows all devices of the current configuration. Select the device you want
to export.
3. Press the Export Device Templ. button. This opens the Export Modbus Device
Template dialog shown in Figure 145. The list on the left side of the dialog shows the
names of the data points which are exported to the template.
4. Press the button and select a template file from the Save dialog.
5. Enter the Creator, Company Name and Version for the template. This information is
stored in the template file, when importing the template file the information is displayed
after selecting the file.
1. Right-click on the folder of the device template that has to be exported or its data point
folder and select Export Device Template… from the context menu.
2. This opens the Export Modbus Device Template dialog as shown in Figure 145.
Proceed as described above.
Time-based: The poll group is triggered on a time base. This means that after a
specific time – the poll cycle – the poll group is processed.
Trigger-based: The poll group is triggered on a special trigger data point. As soon
as the trigger condition is met, the poll group is processed.
Tip: The poll group a data point is attached to can be changed in the properties view of the data
points. The poll group can also be changed for multiple data points using multi-select.
in the tool bar of the Datapoints tab. This opens the Modbus Management dialog.
2. Open the Pollgroups tab. This shows the dialog displayed in Figure 146.
3. The default poll group is selected and its properties are displayed. Enter the name of the
new poll group and enter the poll cycle in seconds. Values in multiples of ‘0.1’ are
allowed for fast polling. Make sure that under Pollgroup Mode Time-based is selected.
4. Press the Save button to store the poll group and continue editing.
5. If a poll group needs to be updated or deleted, select the poll group edit the data and
press the Update Selected or Delete Selected button.
6. Press the Close button to finish editing. When the poll groups have not been saved, a
dialog asks whether the changes have to be saved or not.
in the tool bar of the Datapoints tab. This opens the Modbus Management dialog.
2. In the Modbus Management dialog, open the Pollgroups tab. This displays the poll
groups management tab displayed in Figure 146.
5. Select the new poll group. This enables the Add… and Remove buttons from the
triggers.
6. Press the Add… button and select a trigger data point. This can for example be a binary
user register.
7. The selected trigger data point appears in the trigger list as shown:
8. Select the trigger from the list and check the desired trigger conditions.
10. Press the Save button to store the changes in the poll groups.
2. Right-click in the data point list view and select New Datapoint… in the context menu.
3. This opens the Create New Modbus Datapoint dialog. In the Modbus device list there
is only the SlaveDevice entry. It cannot be de-selected.
4. Enter the data point name and select the desired Modbus Register Type.
5. In the Register Properties group box enter the register start address, the Modbus data
type and optionally scaling and swap settings.
6. Select the data point class, which shall be created and the number of data points below.
7. For analog Modbus Slave registers you may define a metric (SI) and U.S. unit.
Depending on the chosen unit system, the Modbus Slave register will change its
representation (i.e., its value) on the network.
9. The number of Modbus slave register data points is created. The register indices are
incremented for each created register. If a register index is already in use, the data point
for this index is skipped. Created data points are reported with a green check mark.
1. Create the register as described in Sections 8.2.2 and 8.2.7 and select the data point type
User.
2. Click the button and select a structure data type from the chooser dialog.
3. Continue with the data point creation as described in the previous Sections. The
Configurator will create structured Modbus data points.
The status on the right hand side of the dialog shows, if the device is connected or if the
protocol analyzer is stopped or started. When connected to a device, the protocol analyzer
can be started by pressing the Start Protocol button. This starts the protocol analyzer in the
device. Every time a transmission is made on the Modbus port, the transmission is displayed
in the list. Additionally the protocol data is stored in the device in a rotating log file. The
protocol log can hold up to 40 kB of protocol data. So also when the Configurator was not
running for an interesting time, the protocol data can be loaded from the device using the
Load From Device button. The protocol data can be stored as CSV file using the Save
button, with the Clear button, the shown protocol is deleted.
Figure 148 shows a typical protocol analyzer output for the Modbus TCP port. It shows the
following information for TCP:
Seq.: sequence number, which is automatically created in the device. This number
is unique for one port.
Frame Type: ‘TCP’ or ‘Damaged’ when something happened with the frame.
Payload: Payload in hexadecimal numbers (this column cannot be used for sorting).
Figure 148: Typical protocol analyzer output for Modbus TCP port.
Figure 149 shows a typical protocol analyzer output for the Modbus RS-485 port. It shows
the following information for RS-485:
Seq.: sequence number, which is automatically created in the device. This number
is unique for one port.
Frame Type: RTU, ASCII or Damaged when something happened with the frame.
Payload: Payload in hexadecimal numbers (this column cannot be used for sorting)
Figure 149: Typical protocol analyzer output for Modbus RS-485 port.
The frame type Damaged indicates that either a bad packet (malformed frame, CRC error)
was received or that no response packet was received where it is expected.
9 KNX
9.1 Configurator
This section describes how to use the Configurator software for the management of KNX
data points. For further information on the Configurator software refer to Chapter 4.
2. In the System Settings tab enable the KNX for Port 4 and/or for the Ethernet port, as
shown in Figure 150.
Figure 150: Enabling KNX/TP1 and KNXnet/IP in the Project Settings Dialog.
Important: If the KNX Port is deactivated via the checkbox or a firmware or model version is chosen,
which does not support KNX, the complete KNX configuration is deleted. In this case a
dialog is displayed, which has to be confirmed.
If the configurator is connected to a device, the Download button can be used to download
the device configuration.
Group addressing mode: The group addressing mode defines how group addresses
are displayed numerically. This setting is a display property and has no influence on
the KNX communication itself.
o Two-Level: The addresses are displayed as main groups (5 bit) and group
addresses (11 bit), e.g. 6/57.
Unique project ID: This field contains the ETS project ID from the last import, for
example P-053C. This field is used to avoid importing two different projects into
one configuration.
Physical address: This field configures the physical (individual) address of the
device, e.g. 1.2.3. It needs to be unique in the KNX network and needs to match the
line to which the device is connected to.
The following settings are available for the KNXnet/IP interface only:
Multicast address: This IPv4 multicast address is used for sending and receiving
KNX. The default value is 224.0.23.12.
Multicast port: This UDP port number is used for sending and receiving KNX
frames. The default value is 3671. It is recommended to keep the default value, as
some KNXnet/IP devices cannot operate on alternate ports.
Multicast TTL: This is the Time to live value for UDP multicast packets. The
default value is 16.
The following fields are informational only and represent the state of the latest KNX
database import.
Last modification: This field contains the modification time of the ETS project.
Start date: This field contains the start date of the ETS project.
Comment: This field contains the text comment of the ETS project.
Completion status: This field contains the completion status of the ETS project.
Group import settings: This setting allows modifying the mapping of linked
groups:
o Create one communication object for each group: This setting will
create one communication object for each imported group.
o Create one communication object for each send group: This setting will
create one communication object for each send group and attach linked
group addresses to this communication object.
The data point naming rules tab (see Figure 152) allows specifying how data point names are
automatically derived from imported KNX communication objects and groups. The preview
shows how names would look like, when the check marks are modified. Note, that changing
the name components does not change already created KNX data points; this setting affects
only new data points created by an import.
Separator: This setting defines a separator character, which is inserted between the data
point name components. As a default no separator is configured.
Figure 153: Data Point Manager Dialog with KNX import and device folders.
Figure 154: Data Point Manager Dialog with KNX Data Point List.
ETS project
START
change
Interface
Decision
Reserve
Physical address
Download configuration no
Configuration
OK?
yes
DONE
1. If the KNX network consists of a single TP1 line, the device is simply connected to the
line via the LKNX-300.
2. If the KNX network consists of several TP1 lines and couplers, there are two options:
a. If the device shall use group addresses that are mainly used within a line,
add the device to this line. This will reduce the traffic over line couplers.
b. If the device shall communicate with group addresses spread over several
lines, add the device to the main line or to the area line.
3. If the KNX network contains a TP1/IP router and/or has a KNXnet/IP backbone, use the
KNXnet/IP interface.
Note: To make sure that the address is reserved in ETS4, you can add an arbitrary device to the
line, rename it to “Reserved for LINX” and use the assigned address for the KNX interface.
Use this address in the interface configuration dialog (see Section 9.1.2).
To configure the couplers to forward all groups to the device, the following options are
available:
1. Enable the switch Pass through line couplers option in the ETS4 group address or
group range options, as shown in Figure 156. If this switch is set, the couplers will
forward the group addresses towards the main line.
2. Set the “group telegrams” coupler parameters to route instead of filter of the coupler.
As this will forward all group traffic, this is not the recommended method for larger
networks.
3. Drag & drop a group address or an address range on the line which contains the device.
This will add manual filter rules to the affected couplers.
Note: Only configure the group addresses or address ranges used by the device. Forwarding all
group telegrams to the main line will only work well for small installations due to the
backbone traffic. The coupler filter table can be previewed in the ETS4 with the coupler
context menu “Preview filter table …”
To use KNX data points in the IEC61131 program with an older L-LOGICAD installation,
the KNX data types have to be exported as structured text and have to be imported into a
logi.CAD library.
To export KNX types, select Manage Structured Types from the Configurator Tools menu.
Select the export button, as shown in Figure 157.
1 3
1
2
1
4
1
Figure 158: Exporting KNX types as Structured Text.
5. In logi.CAD, create a new library KnxTypes with the context menu New → Library.
6. Select Export/Import → Start ST-Import from the context menu of the newly created
library, as shown in Figure 159.
7. Check that there have not been any warnings or errors during the import.
system settings are written to the device, connect to the device and download the system
settings from the system settings editor.
Use the Web interface to verify that the device has the desired KNX interfaces enabled, as
shown in Chapter “KNX” of the LOYTEC Device User Manual [1].
To import a KNX project file, the context menu entry Import File of the import folder needs
to be selected. This opens a file requester for selecting the .knxproj-File.
After selecting the file, the configuration merge dialog is displayed, as shown in Figure 161.
This dialog allows the initial group address import and is also used to merge configuration
changes when the ETS project has evolved.
The top part of the dialog shows the project description. For the first import, you need to
enter the reserved physical address for this device.
The main part of the dialog is the merge editor which compares the current device
configuration with the KNX project configuration. The table displays the following columns:
Diff: This column displays whether the group has been added (New), is unchanged
(Unchanged), has been changed (Changed), or has been removed (Removed) in
the KNX project.
Resolution: This columns allows to select different actions for each change:
o Create: This action is the default for groups that exist in the KNX project
file, but not yet in the device configuration.
o Delete: This action is the default action for groups that exist in the
configuration, but not in the KNX project file. Deleting a data point being
in use is not possible, as this would break the PLC program or the gateway
configuration.
o Update: This action changes the properties of the group, e.g. if the name
has changed.
o Force: This action forces the configurator to the KNX database file as the
authoritative data source, even if this will break the PLC program or
gateway configuration. It can be used to forcibly delete data points.
New type: This is the data point type in the imported file.
Current type: This is the data point type in the current configuration.
Additional controls:
The filter field above the merge editor allows a substring search to select a subset of
the imported groups. The filter can be disabled with the clear filter button.
The checkbox Show differences only allows displaying only those groups which
have changes.
The action buttons on the right top allow switching the Resolution state of the
selected data points.
If the Propagate changes to device checkbox is enabled (default), changes will not
only be updated in the import folder, but also propagated to existing data points on
the device.
The KNX project import presents all groups which are used in the KNX project by at least
one device. The default data point names are assembled by the group names, separated by
underscores.
To import or merge the KNX project configuration, press the Merge button. To leave the
device configuration unchanged, press Cancel.
To use the data points on the device, multi-select the desired data points and select Use on
Device from the context menu.
When Use on Device is selected on an imported data point, the value of the communication
flags decide which data points are created:
If both, the Write flag and the Transmit flag are enabled, a value data point will
be created.
Now it is possible to use Alarming, Scheduling and Trending on the KNX data points. They
can be exposed to OPC, and can be used as parameters and IEC 61131 variables. Further they
can be used in connections, global connections and math objects.
The KNX data point properties are synchronized between the read and write properties, so
for example changing the data type of the read data point will also change the data type of
the write data point.
Note: Because the PLC program and the OPC tags are derived from the data point name, it is
advisable to keep the data point name constant. If the KNX group names are expected to be
changed, it is a good idea to create data point links in the Favorites folder and use the links
in the PLC program or for the OPC server. Then the KNX project can be merged without
having to take care of the group names.
KNX data points can be scheduled by the generic scheduler. For devices with CEA709
interfaces, the CEA709 scheduler is used to schedule KNX networks. This works also when
the CEA709 node is no commissioned. For BACnet devices, the KNX data points can be also
scheduled by a BACnet scheduler. The configuration of scheduling is described in Section
4.7.
KNX data points can be trended with the generic trends which are described in Section 4.9.
They can also be configured with historic filters as described in Section 4.12.
10 SMI
10.1 Configurator
10.1.1 Activating SMI
Before SMI devices can be added to a data point configuration, the SMI interface in the
project settings must be enabled (LSMI-800 on EXT or LSMI-804 on USB). The project
settings are described in detail in Section 4.3. LOYTEC device models with a dedicated SMI
port have this enabled as a default.
2. In the System Settings tab enable the SMI protocol on the EXT port, as shown in Figure
163. When using an LSMI-804 activate the SMI protocol on the USB port.
Important: If the SMI protocol is deactivated via the checkbox or a firmware or model version is
chosen, which does not support SMI, the entire SMI configuration is deleted. In this case
a dialog is displayed, which has to be confirmed.
If the Configurator is connected to a device, the Download button can be used to download
the device configuration.
Figure 165: Data Point Manager Dialog with SMI Data Point List.
The data points in an SMI device folder cannot be deleted or renamed. Some of their
properties such as OPC exposure, PLC in/out, parameter can be modified. The data points
per SMI device are:
Position (structure): This structured data point has the members function, setting,
rotation, which are compatible with the SNVT_setting definition. When writing this
data point the sunblind is commanded to move to the desired position/rotation (see
Table 13). The SMI device needs to be calibrated for this to work.
PositionFB (structure): This structured data point reflects the feedback of the
sunblind. Its sub-data point ‘pos’ is a SNVT_setting structure which represents the
current position of the sunblind. The sub-data point ‘error_code’ is a binary data
point that reflects an error of that device. The SMI device needs to be calibrated for
this to work.
rawPosFb (analog): This is the analog feedback value of the sunblind in raw motor
steps.
MovingDir (multistate): This feedback data point specifies the current moving
direction of the sunblind (up, down, stopped).
SET_ON d/c d/c Sunblind moves down till the end position.
Note: The valid range for the rotation depends on the min/max rotation setting. Typical ranges are 0° to 90° (0°
to -90° or -90° to 90° are also possible).
Apart from the SMI device folders, a Channels folder exists. This is a fixed folder and
contains the following data points:
Power On X (X=1, 2, etc. per SMI channel): For each physical SMI channel one
power-on data point exists. This data point is set TRUE before communication on
the SMI channel commences. This can be used to attach a relay that turns on power
on the SMI channel to save energy while the motors are left idle.
Power Off Delay (analog): This data point specifies the number of seconds of idle
time until the power-on data point is deactivated again. This is a parameter by
default and thus available in LWEB-900. When setting this parameter to ‘0’ the
power-off feature is deactivated entirely.
2. Right-click in the data point list view and select New SMI Device… in the context menu.
3. In the Create Device dialog enter a Device Name and a Count of devices to be created
as shown in Figure 166.
4. Then click on and choose a template file. As a default the directory of the distributed
SMI device templates is opened. Choose the desired template file.
5. The device type, device model and device manufacturer information is displayed. Then
click Create Device.
1. On the Web interface go to the menu Commission and select the SMI technology.
2. The Web UI lists all SMI devices found in the configuration. To manually assign a
device enter the serial number. If the SMI motor is online, the device is commissioned
and an address assigned.
3. Alternatively, click the Scan SMI network button below and wait for the scan to
complete.
4. From the list of scanned devices, make the SMI device assignments in the drop-down
boxes.
For more details on the commission Web UI and motor calibration refer to the Chapter “SMI”
in the LOYTEC Device User Manual [1].
1. Click on the SMI port folder and create a new folder by choosing New Folder in the
context menu.
2. Select one or more SMI device folders and drag them with the mouse onto a sub-folder.
3. To duplicate an existing SMI device, select the SMI device folder and choose Duplicate
Device from the context menu.
4. To rename an SMI device, select the SMI device folder and choose Rename Device
from the context menu.
Note: When moving SMI device folders to other sub-folders or renaming SMI devices, their
commissioning data is maintained. When duplicating an existing SMI device, the duplicated
devices require to be commissioned.
5. To delete SMI devices, select one or more SMI device folders and choose Delete Device
from the context menu.
The power-on data points are located under the Channels folder under the SMI port:
Power On 6 … 10: These power-on data points correspond to SMI on the EXT ports 1 to 5
on devices that have them.
Power On 11 … 20: These power-on data points correspond to SMI channels on a USB
interface, e.g. the LSMI-804.
Note, that the on-board relays of the LSMI-804 can be used out-of-the-box without
connections of the power-on data points. The power-on data points for the LSMI-804 USB
channels are for use in internal program logic. For more information on how to switch bus
power refer to the LOYTEC Device User Manual [1] SMI Chapter, Section Hardware
Installation.
Also be aware of the fact, that a 2-second delay is introduced after powering on and before
sending any commands to SMI devices. This is necessary to give SMI devices enough time
to start after powering on. This may, however, lead to undesireable delays in manual
operation using buttons. In this case, the feature can be entirely disabled by writing ‘0’ to the
Power Off Delay data point.
11 EnOcean
11.1 Configurator
11.1.1 Activating EnOcean
Before EnOcean devices can be added to a data point configuration, the EnOcean interface
in the project settings must be enabled. The project settings are described in detail in Section
4.3.
2. In the System Settings tab enable the EnOcean protocol on the USB port, as shown in
Figure 167.
Important: If the EnOcean protocol is deactivated via the checkbox or a firmware or model version is
chosen, which does not support EnOcean, the entire EnOcean configuration is deleted. In
this case a dialog is displayed, which has to be confirmed.
If the Configurator is connected to a device, the Download button can be used to download
the device configuration.
Figure 169: Data Point Manager Dialog with EnOcean Data Point List.
The data points in an EnOcean device folder cannot be deleted or renamed. Some of their
properties such as OPC exposure, PLC in/out, parameter can be modified. The data points
named ID, Description, Location are parameters and are also available in LWEB-900.
2. Right-click in the data point list view and select New EnOcean Device… in the context
menu.
3. In the Create Device dialog enter a Device Name and a Count of devices to be created
as shown in Figure 170.
4. Then click on and choose a template file. As a default the directory of the distributed
EnOcean device templates is opened. Choose the desired template file.
5. The device type, device model and device manufacturer information is displayed. Then
click Create Device.
Now it is possible to use Alarming, Scheduling and Trending on the EnOcean data points.
They can be exposed to OPC, and can be used as parameters and IEC 61131 variables. Further
they can be used in connections, global connections and math objects.
EnOcean data points can be scheduled by the generic scheduler. For devices with CEA709
interfaces, the CEA709 scheduler is used to schedule EnOcean networks. This works also
when the CEA709 node is no commissioned. For BACnet devices, the EnOcean data points
can be also scheduled by a BACnet scheduler. The configuration of scheduling is described
in Section 4.7.
EnOcean data points can be trended with the generic trends which are described in Section
4.9. They can also be configured with historic filters as described in Section 4.12.
1. On the Web interface go to the menu Commission and select the EnOcean technology.
2. The Web UI lists all EnOcean devices found in the configuration. To teach-in an
uncommissioned device, click the Teach-In button.
3. The device status changed to “Waiting for Device ID”. Then press the button on the
EnOcean device that shall be associated with this device in the configuration. Or click
Cancel to abort.
4. If the teach-in worked fine, the device status will change to “OK”. The RSSI value is
updated. Expand the Profile item and check the received data value.
5. Expand the Parameters item and enter a device description and location string. This
information will be available in LWEB-900 and on the Web UI.
1. Click on the EnOcean port folder and create a new folder by choosing New Folder in
the context menu.
2. Select one or more EnOcean device folders and drag them with the mouse onto a sub-
folder.
3. To duplicate an existing EnOcean device, select the EnOcean device folder and choose
Duplicate Device from the context menu.
4. To rename an EnOcean device, select the EnOcean device folder and choose Rename
Device from the context menu.
Note: When moving EnOcean device folders to other sub-folders or renaming EnOcean devices,
their teach-in data is maintained. When duplicating an existing EnOcean device the
duplicated devices require a teach-in.
5. To delete EnOcean devices, select one or more EnOcean device folders and choose
Delete Device from the context menu.
12 MP-Bus
12.1 Configurator
12.1.1 Activating MP-Bus
Before MP-Bus devices can be added to a data point configuration, the MP-Bus interface in
the project settings must be enabled. The project settings are described in detail in Section
4.3. LOYTEC device models with a dedicated MP-Bus port have this enabled as a default.
2. In the System Settings tab enable the MP-Bus protocol on the MP-Bus port, as shown
in Figure 171. When using an LMPBUS-804 activate the MP-Bus protocol on the USB
port.
Important: If the MP-Bus protocol is deactivated via the checkbox or a firmware or model version is
chosen, which does not support MP-Bus, the entire MP-Bus configuration is deleted. In
this case a dialog is displayed, which has to be confirmed.
If the Configurator is connected to a device, the Download button can be used to download
the device configuration.
Figure 173: Data Point Manager Dialog with MP-Bus Data Point List.
The data points in an MP-Bus device folder cannot be deleted or renamed. Some of their
properties such as OPC exposure, PLC in/out, parameter can be modified. The remaining
data points such as ‘CurrentPosition’ or ‘PosSetpoint’ are created depending on the MP-Bus
device model.
2. Right-click in the data point list view and select New MP-Bus Device… in the context
menu.
3. In the Create Device dialog enter a Device Name and a Count of devices to be created
as shown in Figure 174.
4. Then click on and choose a template file. As a default the directory of the distributed
MP-Bus device templates is opened. Choose the desired template file.
5. The device type, device model and device manufacturer information is displayed. Then
click Create Device.
Now it is possible to use Alarming, Scheduling and Trending on the MP-Bus data points.
They can be exposed to OPC, and can be used as parameters and IEC 61131 variables. Further
they can be used in connections, global connections and math objects.
MP-Bus data points can be scheduled by the generic scheduler. For devices with CEA709
interfaces, the CEA709 scheduler is used to schedule MP-Bus networks. This works also
when the CEA709 node is no commissioned. For BACnet devices, the MP-Bus data points
can be also scheduled by a BACnet scheduler. The configuration of scheduling is described
in Section 4.7.
MP-Bus data points can be trended with the generic trends which are described in Section
4.9. They can also be configured with historic filters as described in Section 4.12.
1. On the Web interface go to the menu Commission and select the MP-Bus technology.
2. The Web UI lists all MP-Bus devices found in the configuration. To assign an
uncommissioned device, click the Address button.
3. The device status changed to “Press button on device”. Then press the button on the MP-
Bus device that shall be associated with this device in the configuration. Or click Cancel
to abort.
4. If the assignment worked fine, the device status will change to “OK”. The Serial number
and Current pos value is updated.
Alternatively, an online scan can be performed to find and assign MP addresses in one sweep.
Please refer to the MP-Bus Chapter of the LOYTEC Device User Manual [1] for more details.
1. Click on the MP-Bus port folder and create a new folder by choosing New Folder in the
context menu.
2. Select one or more MP-Bus device folders and drag them with the mouse onto a sub-
folder.
3. To duplicate an existing MP-Bus device, select the MP-Bus device folder and choose
Duplicate Device from the context menu.
4. To rename an MP-Bus device, select the MP-Bus device folder and choose Rename
Device from the context menu.
Note: When moving MP-Bus device folders to other sub-folders or renaming MP-Bus devices, their
addressing data is maintained. When duplicating an existing MP-Bus device the duplicated
devices require a new address assignment.
5. To delete MP-Bus devices, select one or more MP-Bus device folders and choose Delete
Device from the context menu.
13 OPC Client
13.1 Configurator
13.1.1 Port Folder
The OPC port folder represents the OPC client interface in the Configurator. In the OPC port
folder, one folder per OPC server is created, which contains the data points for that OPC
server. OPC device folders are identified by the OPC server folder icon known from
LWEB-900. OPC device folders can be deleted, renamed and organized in sub-folders.
Data points and sub-folders in an OPC device folder can be deleted, renamed and re-
organized. Data points can also be OPC exposed, which makes them available as OPC tags
in the local OPC server. All other properties can be edited as described in Section 4.2.4.
Add: Use this button to add a new OPC server from a configuration file of the
device. Supported configuration types include all L-INX, L-GATE, and L-DALI
configuration files. Once the device configuration was loaded, suitable OPC client
data points will be generated and added to the current project.
Refresh Status: This button refreshes the status of the selected OPC device. It will
check if the current data point configuration of the device is still in sync with the
data points present in the current project, or if an update is needed.
Reload: This button reloads the device configuration and updates the OPC data
points in the current project to match the current configuration of the OPC server.
Use this button to update the OPC data points whenever changes were made to the
data point configuration of the OPC server.
Select Source: This button allows you to change the device configuration file
associated with the selected OPC device. In case the name or location of the
configuration file was changed, the OPC device definition must be updated with
the new location of the file.
Open in Editor: This button will launch the configuration software suitable for
the selected OPC device and load the associated data point configuration.
Delete: This button deletes the selected OPC devices and all associated data points.
Note that once the data points have been deleted, there is no easy way to restore
them in a way that references from configuration objects to these data points will
work again. Even after adding the same device again, the new data points will have
different UIDs and all references to the old data points will be broken.
Below the tool bar is a list of all OPC devices. Each of the device entries can be expanded to
show a number of properties. These properties can be edited and are explained below:
Name: Internal name for this OPC device. Note that changing the name will also
change the data point folder name in which the associated OPC data points are
located. In case there are templates or template instances referencing the old data
point folder name, they will need adjustment to fit the new name.
Local Address / Port: These properties specify the primary IP address and port
number which should be used to contact the OPC server.
Local use HTTPS: When this option is checked, the OPC client will use HTTPS
instead of HTTP when contacting the server.
Public Address / Port: These properties define a secondary IP address and port
number, which can be tried by the client in case the server is not reachable via the
primary address. This can be used in NATed environments, where different
addresses need to be used depending on the location of the client.
Public use HTTPS: Same as the option for the local address, but related to the
public address.
Operator Password: The operator password to use when contacting the server.
Write Aggregation: Time in milliseconds to wait for more values to write, before
a write request is sent to the server. This increases efficiency by reducing the
overhead involved in building and transmitting a SOAP request, compared to the
number of values written with that request.
Lower Limit to Min. Send: Minimum time in milliseconds for the Min. Send
property of the OPC data point. Any value lower than this will be replaced by the
specified minimum time.
Config Status: Shows the current status of the server configuration. The
configuration is either shown as up to date, meaning that the current project is still
in-sync with the server configuration, or the status indicates that the server
configuration was changed or removed since it was last imported.
LWEB Time: The time when the server configuration was last imported.
Source Time: The time when the server configuration was last modified.
2. Right-click and choose New OPC Device … from the context menu.
4. In the New OPC Device dialog select Commission later or enter an IP address or host
name and HTTP port for the Web service.
6. Right-click on the OPC device folder and choose Rename device … from the context
menu. Enter the desired OPC device name. This name will be shown on the OPC device
commission Web page as described in the LOYTEC Device User Manual [1].
For example, the tag tree ‘User Registers.channel1’ contains the OPC tags ‘reg1’ to ‘reg3’.
The tag tree ‘User Registers.channel2’ contains exactly the same tags, that represent channel
2. The tag tree ‘User Registers.channel1’ can be exported and imported into the OPC client.
Later on the Web UI, the base path ‘User Registers.channel1’ can be replaced by ‘User
Registers.channel2’.
1. Select a data point folder in a device configuration which has the desired OPC tags.
2. Right-click and choose Export OPC Tags … . Store them in a file ending ‘.opc’.
2. Right-click and choose New OPC Device … from the context menu.
4. In the Import OPC Device dialog, edit the device name and check Commission later.
5. Then click the Create New button. This creates a new OPC device folder for exactly
that OPC tag tree.
2. Enter the IP address in the URL column and click the save icon.
3. The column Replacement Path shows the original OPC base path of the tag import.
4. To relocate it, enter a replacement path, e.g. ‘User Registers.channel2’. Click the save
icon.
14 ekey
14.1 Configurator
14.1.1 Activating ekey
Before ekey fingerprint reader devices can be added to a data point configuration, the ekey
interface in the project settings must be enabled. The project settings are described in detail
in Section 4.3.
2. In the System Settings tab enable the ekey protocol on an RS-485 port, as shown in
Figure 175.
Important: If the ekey protocol is deactivated via the checkbox or a firmware or model version is
chosen, which does not support ekey, the entire ekey configuration is deleted. In this case
a dialog is displayed, which has to be confirmed.
If the Configurator is connected to a device, the Download button can be used to download
the device configuration.
Figure 177: Data Point Manager Dialog with ekey Data Point List.
The data points in an ekey device folder cannot be deleted or renamed. Some of their
properties such as OPC exposure, PLC in/out, parameter can be modified. The data points
per fingerprint reader are:
Authenticated (binary): This register becomes TRUE for a short period of time when
a finger was authenticated and then falls back to FALSE.
Authenticated user name (string): When a finger is authenticated, it contains the user
name. After that it falls back to the empty string.
Enable (binary): When this register is set TRUE, the finger reader is enabled and
performs authentication of fingers. When setting FALSE this particular fingerprint
reader device is disabled. This is a parameter by default and thus available in
LWEB-900.
EkeyAddr (string): This data point contains the ekey device address.
Users (string): This parameter data point contains the user and finger enrollment
data stored on that reader device. The parameter data point is available in
LWEB-900 and can be used to distribute user enrollment over reader devices.
Apart from the ekey fingerprint reader device folders, a Groups folder exists. This is a fixed
folder and contains 10 group enable data points:
2. Right-click in the data point list view and select New ekey Device… in the context menu.
3. In the Create Device dialog enter a Device Name and a Count of devices to be created
as shown in Figure 178.
4. Then click on and choose an ‘.ekey’ device template file. As a default the directory
of the distributed ekey device templates is opened. Choose the desired template file.
5. The device type, device model and device manufacturer information is displayed. Then
click Create Device.
1. On the Web interface go to the menu Commission and select the ekey technology.
2. The Web UI lists all ekey reader devices found in the configuration. To enroll an
uncommissioned device, which is connected and online, click the Scan ekey network
button.
3. When the scan completes it lists all found ekey devices. Those which are unassigned
have a drop-down box.
4. Choose an uncommissioned reader device from the configuration and click on the
Assign button.
5. The assigned reader should now go online and show address and serial number in the
device list. Edit a description and click the save icon.
1. On the commission Web UI locate the desired reader in the device list and click on the
Show users icon .
2. The user list of the selected reader device is displayed. Click on the plus icon to add
a new user.
3. To edit the user click the pencil icon which opens the User configuration page as
shown in Figure 179. Enter a user name and select a finger to enroll, e.g. left index finger.
4. Then click on the enroll button and move the correct finger as described in the
instructions.
5. Repeat this enrollment with other fingers as well. At least two fingers should be enrolled.
To finalize click on Save Settings.
1. In the ekey User Configuration page of a given user, click on the Export link to
generate a user configuration XML file.
2. Then navigate to a different reader device and pull up the User List of that device.
3. Add a new user as described above. On the user configuration page of that new user,
click on the Choose File button. Select the previously stored XML file.
15 DALI
LDALI-ME201-U
LDALI-ME204-U
LDALI-3E101-U
LDALI-3E102-U
LDALI-3E104-U
LDALI-ME204
LDALI-E201-U
LDALI-3E101
LDALI-3E102
LDALI-3E104
LDALI-E101-U
LDALI-3101-U
15.1.1 Configurator
To install and manage the DALI channels the tabs DALI Installation, DALI Groups, DALI
Channels, DALI Parameters and DALI Scenes are used:
The DALI Installation tab is used to assign DALI ballasts to Lamp Actuator
objects, DALI sensors to Sensor objects, and DALI buttons to Button objects.
Additionally, a name can be assigned to each ballast, sensor, and button. For details
see Section 15.1.1.1.
The DALI Groups tab is used to assign ballasts to DALI groups. Additionally, a
name can be assigned to each group. For details see Section 15.1.1.2.
The DALI Channels tab can be used to virtually connect two DALI channels
(“bridging”). Additionally, a name can be assigned to each channel. For details see
Section 15.1.1.3.
The DALI Parameters tab is used to configure parameters related to DALI devices,
groups and channels and to the lighting application (if available). For details see
Section 15.1.1.4.
The DALI Scenes tab can be used to set up DALI lighting scenes. For details see
Section 15.1.1.5.
The Scan Channel button starts a scan of the DALI channel. When pressing the
button a window showing the scan progress will be shown (see Figure 181). After
the scan the devices found will be listed in the DALI network scan results section
(number 3 in Figure 180) of the DALI Installation tab.
Pressing the Reset button will clear the DALI configuration of the selected channel
including all DALI device assignments, device names, group assignment, group
names, and the channel configuration. If on-line it will also reset all DALI devices
on the channel to factory defaults.
The Automatic Status check box allows enabling and disabling the periodic update
of the status of the devices in the DALI network database. Pressing Get Status
allows updating the device status manually if automatic status update is disabled.
Note: If there is no IP connection available, disable automatic status update in case there is no
need to monitor the status of DALI devices as the status update uses network bandwidth.
The Protocol Analyzer button will open the DALI Protocol Analyzer window. See
Section 15.1.1.6 for details.
Lamp/Sensor/Button name: Contains the name of the DALI device. Double click
on the name to modify it. The name should be chosen in a way which allows
identifying the lamp (e.g. room number/ballast number). This is specifically
important in off-line work flow (see Section 15.1.2.2) for the installer to pick the
correct lamp during the final on-line phase and to identify a lamp if it reports an
error.
Type: Show the type and optionally the make of the DALI ballast, sensor, or button
assigned. For assigned and online ballasts this information is read from the ballast.
In case of unassigned ballasts and buttons, the DALI device type can be chosen
using a drop-down box or Set device type… from the context menu (can be used
with multi-select). Selecting the device type allows to configure DALI device type
specific parameters during off-line preparation including the button functions.
Further, this information is used during device assignment when on-line to ensure
only a matching device type can be assigned. For information on the device type
reported by a ballast please refer to the documentation provided by the vendor of
the ballast or luminaire.
Status: Shows the status of the DALI device if a DALI ballast, sensor, or button is
assigned and the DALI configuration was downloaded. If the DALI device is online
the status is OK, if it is not reachable via the DALI network it is Offline. The device
is marked modified if its configuration/assignment was changed, but not yet
Short Addr.: Shows the DALI short address of the device. The DALI short address
can be in the range 0 to 63.
Serial Nr.: Shows the serial number of the device, if available. If the serial number
of the device is known during preparation phase of off-line work flow (see Section
15.1.2.2) it can be entered by double clicking on this field. In this case the
assignment is automatically performed once the DALI configuration is downloaded
to the device.
A device can be winked by selecting the corresponding row and clicking on the Wink button
located between the DALI network database section and the DALI scan result section.
Short Addr.: Shows the DALI short address of the device. For DALI devices which
do not contain a short address it will be automatically assigned during network scan.
Type: Show the type and optionally the make of the DALI device.
Devices found during a DALI network scan can be assigned to Lamp Actuator, Sensor, or
Button objects either one by one or using the Auto Assign button.
To manually assign a device select one device in the scan results list on the right side and an
unassigned entry in the Lamp Actuator, Sensor, or Button objects lists on the left side and
press the Assign button. Alternatively you can drag a device from the scan results list and
drop it to an unassigned entry in the object lists. DALI ballasts must be assigned to Lamp
Actuator objects. DALI sensors must be assigned to Sensor objects. DALI buttons must be
assigned to Button objects.
To remove an assignment from an object select the corresponding entry and press the
Unassign button. The entry in the object list will become unassigned again and the DALI
device will be moved to the scan results list to the right.
To identify a device in the scan results list select the corresponding row and click on the
Wink button. The duration of the Wink action can be chosen in the drop down box besides
the button. When a device winks it dims between its minimum and maximum value for the
specified wink duration.
Tip! Use auto assign if you do not care about the assignment of a specific device. This is typically
the case if you are using the on-line work flow (do not prepare DALI installation off-line)
and you do not use the Lamp Actuator objects to control the lights (rather use Group or
Channel Actuator objects).
Similar to the DALI Installation tab the drop down box in the top left corner of the tab allows
you to choose the DALI channel to work with. Below there is a table which contains one row
for each DALI ballast (64) and one column for each DALI group (16). To add/remove a
device to/from a group check/uncheck the check box where the corresponding row and
column are crossing. The default name of a group (e.g. “Group 00”) can be changed by double
clicking on it.
The checkbox Recover group information from devices allows keeping the group
configuration in the devices (ignoring the group configuration defined in the LINX
Configurator). It is automatically unchecked if the group configuration is changed with the
LINX Configurator.
The default name of a channel (e.g. “Channel 1”) can be changed by double clicking on it in
the first row of the table.
To connect two channels by channel bridging, check the check box where the corresponding
row and column are crossing. For more details on the DALI channel bridging function refer
to the LOYTEC Device User Manual [1].
The selected node in the tree view (1) determines which objects are displayed in the list view
(2). If the root node (e.g. LDALI-3E104-U) is selected, all objects are displayed, if a branch
is selected, the objects in or below this branch are displayed. For example, selecting
LDALI-3E104-U/Lamp Actuators displays all Lamp Actuator objects on all DALI
channels, whereas selecting LDALI-3E104-U/Lamp Actuators/Channel 1 displays only
Lamp Actuators of DALI channel 1.
In the object list (2) one or multiple objects can be selected. The properties of the selected
object(s) are displayed and can be edited in the parameter view (3). In this way it is possible
to change a parameter for multiple objects at once.
All DALI ballast, sensor, group and channel parameters can be configured. On L-DALI
models in addition the parameters of the Constant Light Controller objects and Sunblind
Controller objects are available. Details on the L-DALI parameters can be found in the
L-DALI User Manual [3].
In case a single Constant Light Controller or Sunblind Controller is selected the internal
bindings section (4) becomes active and allows determining which sensors (occupancy &
lux) are used as inputs to and which outputs (light groups or SMI drives) are controlled by
the selected constant light or sunblind controller instance, respectively.
Click on the to add an input or output. Use the drop down box to select a sensor (input) or
a light group/SMI drive (output). Click on to remove an input or output.
In case of Constant Light Controllers one lux level sensor, but up to 16 occupancy sensor
inputs can be configured for each controller instance. Whenever at least one occupancy
sensor reports occupancy the area controlled by the controller instance is considered
occupied. The drop down box allows to select a DALI sensor (occupancy/lux) instance or a
data point.
To select a data point select Choose data point… from the drop down box. A data point
selection dialog appears. Choose a data point and click on OK. Any analog data point can be
selected as lux sensor, a binary data point as occupancy sensor. For the latter select, which
value shall be considered as unoccupied and which as occupied (see Figure 185).
Figure 185: Select occupied and unoccupied value of data point based occupancy.
As outputs for each of the two light bands up to 16 DALI groups can be selected. The primary
light band is near the inside of the building, the secondary light band is near the window
front. Depending on the outdoor light intensity the primary light band has to be brighter than
the secondary light band to illuminate the room evenly.
On LDALI-10x models NV bindings can be used in parallel to the internal bindings. When
adding the first manual Constant Light Controller binding on a channel all automatic bindings
of that channel will be disabled. Automatic bindings can be re-enabled in the CEA-709
Settings tab of the Project Settings (see Section 5.1.2).
In open office space applications, where different zones of an open space are controlled by
different constant light controller instances, the controllers of neighboring zones can be
linked together by configuring up to 16 neighboring controller instances for each Constant
Light Controller. Whenever a zone is occupied and its lights are on, all neighboring
zones/CLCs are also kept at a defined minimum level even if they are not occupied. See the
L-DALI User Manual [3] for details on the function “Neighboring Controller”.
Similar for each Sunblind Controller instance one lux level sensor, but up to 16 occupancy
sensor inputs can be configured. Whenever at least one occupancy sensor reports occupancy
the area controlled by the controller instance is considered occupied. Up to 16 SMI drives
can be selected as outputs for each instance. On LDALI-10x models NV bindings can be
used in parallel to the internal bindings.
DALI buttons (Channel 1-4): See the DALI section in the LOYTEC Devices User
Manual [1] for information on which DALI button devices are supported.
Note: Not all DALI button device types are configurable. Therefore, a button device type supporting
button functions must be selected or assigned on the DALI installation tab before the
corresponding button object can be configured.
EnOcean: Profiles Rocker Switch, 2 Rocker (F6-01) and 4 Rocker (F6-03), and Position
Switch (F6-04) are supported. EnOcean devices must be created in the Datapoints tab
before being available for button function configuration (see Chapter 11).
Data Points: Any binary data point can be used to trigger button functions. Data points
can be used to configure button functions for buttons created in L-WEB graphic projects,
for buttons connected to digital inputs of remote IO modules (e.g. BACnet, LonMark,
etc.) and for DALI buttons connected to DALI channels on other LDALI controllers. To
use an existing data point as trigger for a button function click on the button Add Data
Point Button… in the special functions (5) of the DALI Parameters tab.
In case one or more Button objects supporting button functions are selected the section for
button function configuration (4) becomes active (see Figure 187). It allows the configuration
of the function executed when a button is operated.
The Mode drop down box allows to select whether a switch or a push button is connected to
the button input (in case both are supported by a button device/input). The Function drop
down box allows selecting the function to be performed when the button is pressed. See Table
14 for a list of available function. If the function is used to control light, the Destination
column allows selecting the DALI group or channel to be controlled. If the function requires
additional arguments (e.g. dim values or scene numbers) they are configured in the columns
Argument 1 and Argument 2.
Function Description
Disabled No action
Network data point Button input status will be reflected by a data point.
On (maximum) Switch on (recall maximum).
On (last value) Switch on to last known value.
Note: Requires storing value when switching off.
Auto (Re-)activate L-DALI constant light controller of target group.
Off Switch off.
Off (store value) Store last value and switch off.
On/Off Toggle between on and off whenever button is pressed or
switch is changed depending on current status (changeover
switch). Switch light on when it is off and switch light off
when it is on.
Auto/Off Toggle between active L-DALI constant light controller and
off whenever button is pressed or switch is changed depending
on current status (changeover switch). Switch light on when it
is off and switch light off when it is on. Note: Switching off
will deactivate the L-DALI constant light controller.
Up Dim up while button is pressed. The dim speed is determined
by the fade rate parameter of each ballast.
Down Dim up while button is pressed. The dim speed is determined
by the fade rate parameter of each ballast.
Up/Down Toggle between dimming up and down whenever button is
pressed. Dim as long as button is kept pressed. The dim speed
is determined by fade rate parameter of each ballast.
On/Up Switch on (recall maximum) if button is pressed shortly, dim
up when button kept pressed. The dim speed is determined by
the fade rate parameter of each ballast.
On (last value)/Up Switch on to last known value if button is pressed shortly, dim
up when button kept pressed. The dim speed is determined by
the fade rate parameter of each ballast.
Auto/Up (Re-)activate L-DALI constant light controller if button is
pressed shortly, dim up when button kept pressed. The dim
speed is determined by the fade rate parameter of each ballast.
Note: Diming up will deactivate the L-DALI constant light
controller.
Off/Down Switch off value if button is pressed shortly, dim down when
button kept pressed. The dim speed is determined by the fade
rate parameter of each ballast.
Off (store value)/Down Store last value and switch off if button is pressed shortly, dim
down when button kept pressed. The dim speed is determined
by the fade rate parameter of each ballast.
On/Off and Up/Down Toggle between on and off whenever button is pressed shortly
depending on current status (changeover switch). Toggle
between dimming up and down whenever button is pressed
longer. Dim as long as button is kept pressed. The dim speed is
determined by the fade rate parameter of each ballast.
Auto/Off and Up/Down Toggle between active L-DALI constant light controller and
off whenever button is pressed shortly depending on current
status (changeover switch). Toggle between dimming up and
down whenever button is pressed longer. Dim as long as button
is kept pressed. The dim speed is determined by the fade rate
parameter of each ballast. Note: Diming up/down and
switching off will deactivate the L-DALI constant light
controller.
Function Description
On (last value)/Off and Toggle between switching on to last value and off (including
Up/Down storing the last value) whenever button is pressed shortly
depending on current status (changeover switch). Toggle
between dimming up and down whenever button is pressed
longer. Dim as long as button is kept pressed. The dim speed is
determined by the fade rate parameter of each ballast.
Dim to Dim to the value entered as argument 1.
Dim to (toggle) Toggle between dim value entered as argument 1 and dim
value entered as argument 2 whenever button is pressed or
switch is changed.
Recall scene Recall the scene configured with argument 1.
Recall scene (toggle) Toggle between recalling scene configured with argument 1
and scene configured with argument 2 whenever button is
pressed or switch is changed.
Colour warmer Ramp up colour temperature as long as button is pressed.
Note: Requires ballasts of type colour control (device type 8)
supporting the colour type colour temperature.
Colour cooler Ramp down colour temperature as long as button is pressed.
Note: Requires ballasts of type colour control (device type 8)
supporting the colour type colour temperature.
Sunblind Up Short Press: Rotate sunblinds until completely open, then move
up.
Long Press: Drive to upper end position.
Sunblind Down Short Press: Rotate sunblinds until completely closed, then
move down.
Long Press: Drive to lower end position.
Sunblind Auto Relinquish manual override of sunblind controller application
and resume automatic operation.
Sunblind Short Press: Toggle between moving sunblinds up and down,
Up/Down/Auto with stop in-between (each second button press).
Long Press: Relinquish manual override of sunblind controller
application and resume automatic operation.
Table 14: Button functions
Multi-select different button objects to change the configuration of multiple buttons at once.
Only changes are applied to the selected objects. The rest of their configuration remains as
is. This allows to quickly change selected values (e.g. button function) for multiple button
objects.
If buttons are used with Constant Light Controller applications to allow manual and
automatic operation please see the L-DALI User Manual [3] on how buttons can interact with
the Constant Light Controller application.
Depending on the selected objects the following special functions (5) are available:
To counter any non-linearity the sensor can be calibrated for up to seven different daylight
illumination levels. However, in most cases it is sufficient to calibrate the sensor only once.
The best result is achieved if the illumination level is near the setpoint. To calibrate the sensor
perform the following steps:
1. Measure the current lux level at the reference area (e.g. desk) using a luxmeter.
2. Enter the measured lux level in the input field Measured Lux Level.
If the sensor installation scenario is similar for multiple sensors, the calibration information
can be applied to other sensor instances by selecting them in the box below the button
and clicking the button. Similar the calibration information can be exported and imported by
using the buttons and .
The current gain table can be uploaded from the device by pressing the button . It can be
cleared with the button .
1. the artificial light in the controlled area/room is dimensioned outside the range of 500lx
to 700lx. In a typical office room artificial light is dimensioned for around 600lx (500lx
+ 20%). If in the rooms artificial light is dimensioned dimmer or brighter the artificial
light factor is used to parameterize the amount of lux provided by the rooms artificial
light.
2. the difference in sensor sensibility for artificial light vs. for natural light must be
considered. While the natural light comes through the window, the artificial light is
provided by luminaires mounted on the ceiling. Thus, the reflection and light distribution
is different depending on the light source. This results in a different ratio of the lux level
measured by the sensors mounted on the ceiling to the lux level on the reference area
(e.g. desk). In most use cases this difference is negligible. However, if it is not the
artificial light factor is used to parameterize this influence.
To measure the amount of light provided by the rooms artificial light the following steps have
to be performed:
2. Switch the lamp off. Measure the lux value on the reference area (e.g. desk) with a
luxmeter and enter it in the first Luxmeter input field. Enter the value measured by the
light sensor in the first Light Sensor input field.
3. Switch the lamp on. Measure the lux value on the reference area (e.g. desk) with a
luxmeter and enter it in the second Luxmeter input field. Enter the value measured by
the light sensor in the second Light Sensor input field.
If the lighting output of the rooms artificial lighting is known (in lux on the reference area)
you can use those values as an approximation instead of measuring:
2. Enter the lux value corresponding to the lighting output of the room in both “ON” fields
(Luxmeter and Light sensor).
1. a light sensor connected via CEA-709 or BACnet is used and this sensor cannot be
calibrated.
2. the constant light controller is operated in CONTROL mode to define the ratio between
the measured outdoor lux level and the resulting indoor lux level.
1. Switch the light off and measure the current lux level at the reference area (e.g. desk)
using a luxmeter.
3. Enter the value measured by the light sensor in the field Light sensor.
LDALI-10X
The button Higher increases the priority of the selected event; the button Lower decreases
the priority.
Events can be disabled with the Remove button. Previously deleted events appear in the drop-
down list and can be enabled by pressing the Add button.
Per default an event which is activated with identical parameters multiple times in succession
will be executed multiple times. For some events (e.g. local control) this default behavior can
be changed by pressing the toggle re-evaluation button. The text “not re-evaluated” will
appear beside the event and successive identical commands will be ignored.
To store the modified event priorities press the Modify button. The event priorities can be
reset to the default values by pressing the Reset to default button.
LDALI-20x
In this dialog the BACnet priorities for the events automatically generated by the Sunblind
Controller application can be configured. In BACnet higher values correspond to lower
priorities. BACnet priorities may be in the range 1 to 16. The value 0 disables the
corresponding event.
Note: Each event must use a unique BACnet priority value! That is, no two events may use the same
BACnet priority value.
For both tests – function and duration test – a test interval in days and the time and date of
the next execution of the test can be specified. A Test Interval of 0 disables auto-test of the
selected test. Click Configure to store the new values in the selected devices. Click on
Upload to read the currently configured values from the device.
Note: The resolution of the duration test interval is 7 days, the resolution of the delay to the next
test execution is 15 minutes. In both cases the value entered will be rounded to the next
appropriate value.
Test results will be stored in the appropriate emergency light test log (see LOYTEC Device
User Manual [1]).
Each DALI ballast allows to store up to 15 scenes1. For each scene a name can be configured.
Click on the scene name to edit it. For each ballast a different dim level can be configured
for each of its scenes. If recalling the scene shall not affect the ballast’s dim level set the
value to ‘--‘.In addition a name can be assigned to each scene. Start editing by double-
clicking on the name.
1
DALI ballasts support up to 16 scenes. Scene 15 is used by the LOYTEC DALI controller
and the LOYTEC DALI buttons to store the last dim value when switching off and therefore
is not available.
Figure 196: Scene colour selection for devices supporting colour type XY Coordinates.
For ballasts supporting colour control (DALI device type 8, DT8) the scene can include
colour information, too.
For devices supporting Colour Temperature only two values can be entered for each scene.
The upper value is the dim level, the lower value is the colour temperature for the scene. In
all cases enter ‘--‘ in the upper value if the dim level shall not be affected when the scene is
recalled and enter ‘--‘ in the lower value if the colour shall not change when the scene is
recalled.
When clicking on the button a colour picker dialog as shown in Figure 196 appears. The
left side of the dialog shows the colour type(s) supported by the ballast. For ballasts
supporting multiple colour types, first choose the appropriate type. Depending on the selected
type the colour information is configured as follows:
Colour Temperature (see Figure 197): This colour type is also referred to as tunable
white. Here a slider allows to select the colour temperature between a “warmer” white
(red) and “cooler” white (blue). Alternatively, the desired colour temperature can be
entered as number in Kelvin. Note, that a lower Kelvin value is considered a “warmer”
white and vice versa.
XY Coordinates (see Figure 196): This colour type allows choosing a colour in the CIE
1931 colour space. Either manually enter the x and y coordinate of the scene colour
within CIE 1931 colour space or pick the colour by clicking in the colour diagram on the
left side of the dialog. The last six colour values used are shown in the history below the
colour diagram for quick reference.
RGBWAF (see Figure 198): For this type the resulting colour is composed by selecting
a percentage value of 0% to 100% for the intensity of up to six predefined channels (red,
green, blue, white, amber and free colour). Note, that a specific ballasts supporting
RGBWAF might only support a subset of those six channels (e.g. only red, green, blue).
Primary-N: Similar to RGBWAF up to six colour channels are available for composing
the resulting colour. However, in this case the colours represent the primary colours of
the LEDs used on the luminaire. Similar to RGBWAF, a specific ballast might support
less than six primary-N channels.
When online and the check box Live preview is checked the ballast will dim to the selected
colour whenever a new value is selected.
Note: When an offline pre-configuration of scenes shall be performed all ballasts where scene
values shall be configured must be given a non-default name to make them appear in the
DALI Scenes tab. If the scenes shall containing colour information the device type colour
control must be selected for the corresponding ballasts in the DALI Installation tab.
Scenes are stored for each ballast, but are typically recalled for a group. To show only the
ballasts belonging to a certain group select the group in the drop down box next to the channel
selection drop down box.
When online the scene can be tested without download by clicking on the corresponding
button. This will dim the ballasts selected by the current filter to the values
configured for the scene.
Scenes can be recalled using buttons or by the LOYTEC DALI controller via its data point
interface.
Check boxes allow selecting the DALI channels to log. Multiple channels can be logged at
the same time. With the Set filter flags button the number of logged frames can be reduced
by configuring a filter to logging only certain frame types. By pressing the button Start Log
or Stop Log the protocol analyzer can be started and stopped respectively. When stopped
click on Save to store the protocol log as a CSV file. Clear clears the log data. Check
Automatic Scrolling to always show the newest frames by automatically scrolling to stay at
the end of the page. The check box Log to file allows long time logging to a file.
Timestamp (Example: “11:08:05.284”): Local time on the device when the frame was
received (end of frame).
Settling time (Example: “45.00TE”): Settling time between this and the previous frame
in Te (1 Te = 416.67 μs). The maximum value shown is “99TE”.
Direction (Example: “->”): Frames sent by the LOYTEC DALI controller are marked
by “->”, while frames received are marked by “<-“.
Frame type (Example: “REQ”): Type of DALI frame. Some possible frame types are
shown in Table 15.
In brackets the channel, group or – if the device is assigned - device name is shown,
respectively.
Message type & data (Example: “QUERY STATUS”): Shows the DALI message type
and the corresponding data (argument).
15.1.2.1 On-Line
The flow diagram in Figure 200 shows the steps that need to be followed in order to set up
the DALI network when the LOYTEC device and the DALI network including all DALI
devices (e.g. ballasts, sensors, etc.) are available on-line.
START
DONE
First, the LINX Configurator must be started and a connection must be established to the
LOYTEC device. In the Configurator, the DALI network is scanned for DALI devices and
the devices are setup and assigned to DALI groups (see Section 15.1.1.1 and 15.1.1.2). Then
the parameters for the DALI devices, groups and channels and – in case of L-DALI models
– for the light application and the sunblind application can be configured (see Section
15.1.1.4). Optionally, DALI scenes can be configured (see Section 15.1.1.5). Finally, the
configuration needs to be downloaded to the LOYTEC device.
To add more DALI devices, change DALI group assignment or application parameters
simply repeat the steps described above.
15.1.2.2 Off-Line
The flow diagram in Figure 201 shows the steps that need to be followed in order to pre-
configure the DALI network off-line. In this scenario the first steps can be performed without
the LOYTEC device and the DALI network being physically available. This allows to
prepare the on-line commissioning and thus to speed up the time required for on-site
installation. Further, some steps of the on-line commissioning part can be performed by less
skilled personnel using the Web Interface of the LOYTEC device.
Start the Configurator as a plug-in or stand-alone Start the Configurator as a plug-in or stand-alone
Select correct LOYTEC device model in the Model Load configuration file created during off-line
menu preparation
Setup DALI device names, groups, and ballast types Download configuration to LOYTEC device
DONE OFF-LINE
First, the LINX Configurator must be started. Select the correct LOYTEC device model in
the Model menu. Note, that the device is off-line. Next setup names, groups and optionally
device type for the DALI devices (see Section 15.1.1.1 and 15.1.1.2). The names assigned
must allow identifying physical devices later on (e.g. “Room 301-1” for first ballast in room
301). The device type (e.g. emergency light) must be selected if any device type specific
parameters shall be configured in the next step. Then the parameters for the DALI devices,
groups and channels and – in case of L-DALI models – for the light application and the
sunblind application can be configured (see Section 15.1.1.4). Optionally, DALI scenes can
be configured (see Section 15.1.1.5). Save the created configuration to a file.
Once the LOYTEC device and the DALI network is physically available, start the LINX
Configurator again and load the file created during the off-line preparation. Now a connection
must be established to the LOYTEC device.
To complete the commissioning of the DALI network the DALI devices in the network must
be assigned to the names entered during off-line preparation. This task can be performed in
two ways:
Use the DALI Installation tab in the LINX Configurator to perform a scan of the DALI
network and assign all DALI device found (see Section 15.1.1.1.3). Then download the
configuration to the LOYTEC device.
Download the Configuration to the LOYTEC device and use the DALI web-UI of the
device to accomplish the DALI device assignment (see LOYTEC Device User Manual
[1]).
Finally, it is recommended to upload and save the complete configuration to a file for being
able to replace an LOYTEC device. Additionally a backup should be created.
To add more DALI devices, change DALI group assignment or application parameters it is
recommended to use the on-line work flow (see Section 15.1.2.1).
(DALI short address), scene values, group names and group assignment as configured on the
DALI Installation, DALI Groups, DALI Channel and DALI Scenes tabs. The Parameters
contain the parameters of the L-DALI light and (if available) sunblind applications, including
CLC Bindings and button functions as configured on the DALI Parameters tab.
Note: As new DALI devices are commissioned during the download of the DALI configuration this
operation may take some time depending on the number of DALI devices to be commissioned.
If the dialog shown in Figure 202 appears, the software has detected a version mismatch
between the DALI configuration in the device and the one in the Configurator.
The DALI configuration on the device was changed using the web interface.
An old configuration file version was loaded to the LINX Configurator software.
No configuration file was loaded to the LINX Configurator software but the device
contains a DALI configuration.
If you are sure, you are loading a matching DALI configuration to the device, you can answer
the question by clicking on Yes. In any case the log (“Show details”) will contain the message
“Syncro counter did not match” for each affected channel.
If errors occurred during the configuration download, clicking on the button Show Details
opens a Log-window. The Configuration Download Details log window as shown in Figure
203 opens up.
To filter out info messages use the button . Similar warning messages can be filtered by
pressing the button and error message by pressing the button . Press the Save button to
store the log file on your harddrive (e.g. for sending in to LOYTEC support for analysis).
LDALI-PLC4
LROC-400
LROC-401
For this workflow, the LINX Configurator is used either standalone or as L-STUDIO Add-
In.
15.2.1 Configurator
15.2.1.1 Data Point Manager for DALI
The Configurator uses a central concept to manage data points. The data point manager is
used to select, create, edit and delete data points. The dialog is divided into three sections:
The folder list (Figure 204),
The data point list (Figure 205),
And a property view.
Figure 205: Data Point Manager Dialog with DALI Channel Data Point List.
Depending on the model certain folders are automatically created: On all models one folder
per DALI channel. On the LDALI-PLC4 folders for all 16 DALI groups per channel are
created in addition. The creation of the latter can be disabled in the project settings. These
automatically created folders cannot be deleted.
The data points in a DALI device/group/channel folder cannot be deleted or renamed. Some
of their properties such as OPC exposure, PLC in/out, parameter can be modified. The data
points marked with the Param flag are parameters and are also available in LWEB-900.
2. Right-click in the data point list view and select New DALI Device… in the context
menu.
3. In the Create Device dialog enter a Device Name and a Count of devices to be created
as shown in Figure 206.
4. Then click on and choose a template file. As a default the directory of the distributed
DALI templates is opened. Choose the desired template file. See Section 15.2.2.2 for
more information on DALI templates.
5. The device type, device model and device manufacturer information is displayed. Then
click Create Device.
DALI Actuators
DALI lamp actuator (LampActuatorStd.dali): The Standard DALI Lamp Actuator
provides data points for dimming, either absolute (DimLevel) or relative and via scenes
(Command). The data point Command further allows various other DALI commands
(e.g. burn-in, emergency test, etc.) to be triggered. The data points DaliCfg, Group and
NominalPower can be used for configuration of the DALI ballast. Feedback provides
the current dim level and Status provides various status information (e.g. errors,
emergency test execution) provided by the ballast.
DALI lamp actuator disabled (LampActuatorDisabled.dali): Is a minimal set of data
points required for the configuration of the ballast. It is intended to be used if lamps are
only controlled via groups or channel wide and never one by one. By using the template
in this use case the number of data points can be significantly reduced.
DALI lamp actuator emergency (LampActuatoremergency.dali): Similar to DALI
lamp actuator, but with an additional data point for the battery charge status
(BatteryCharge).
DALI lamp actuator colour (LampActuatorColourControl.dali): Similar to DALI
lamp actuator, but with an additional data points for colour control. Output colour can
either be controlled via the Colour data point, mapping the three DALI colour control
methods (colour temperature/Tc, xy-coordinate, RGBWAF), or via Hue and Saturation
data points.
DALI group actuator (GroupActuator.dali): Similar to DALI lamp actuator, but for
controlling DALI groups. Thus, it contains no configuration data points. Data points for
colour control (Colour) and emergency lights (BatteryCharge) are always provided.
Energy provides the accumulated energy of all group members, while BatteryCharge
and RunHours provided the minimum and maximum value, respectively.
DALI channel actuator (ChannelActuator.dali): Similar to DALI group actuator, but
for controlling all ballasts on a DALI channel.
DALI Sensors
DALI multi-sensor (SensorMulti.dali): This template contains the data points for a
typical DALI multi-sensor, providing occupancy (Occupancy) and up to two lux level
values (Lux, Lux2). Gain and Gain2 are used to store a calibration gain table of the two
lux sensors. FieldCalibr is used to perform calibration for the first lux level sensor: The
field index is set to the index in the gain table (0-6), where the calibration value shall be
stored, and value to the value currently measured with a lux meter at the reference area.
DALI Buttons
DALI push-button (ButtonDigital.dali): This template is used for standard (DALI-2)
push-buttons. It can map up to 32 push-button instances. The status of each button is
reflected by the corresponding bits of the Button data point. The number of push-button
instances available on the assigned device is provided in the Capabilities data point.
DALI event button (ButtonEvent.dali): Some (proprietary) DALI devices provide
information on buttons via Events (e.g. Philips OccuSwitch and ActiLume IR-remote).
Those type of devices can be mapped with this template. Each button press is represented
by an event code provided via the Event data point.
Now it is possible to use Alarming, Scheduling and Trending on the DALI data points. They
can be exposed to OPC, and can be used as parameters and PLC variables. Further they can
be used in connections, global connections and math objects.
DALI data points can be scheduled by the generic scheduler. For devices with CEA709
interfaces, the CEA709 scheduler is used to schedule DALI networks. This works also when
the CEA709 node is no commissioned. For BACnet devices, the DALI data points can be
also scheduled by a BACnet scheduler. The configuration of scheduling is described in
Section 4.7.
DALI data points can be trended with the generic trends which are described in Section 4.9.
They can also be configured with historic filters as described in Section 4.12.
1. Click on the DALI port folder and create a new folder by choosing New Folder in the
context menu.
2. Select one or more DALI device folders and drag them with the mouse onto a sub-folder.
3. To duplicate an existing DALI device, select the DALI device folder and choose
Duplicate Device from the context menu.
4. To rename a DALI device, select the DALI device folder and choose Rename Device
from the context menu.
Note: When moving DALI device folders to other sub-folders or renaming DALI devices, their
assignment data is maintained. When duplicating an existing DALI device the duplicated
devices require a new assignment.
5. To delete DALI devices, select one or more DALI device folders and choose Delete
Device from the context menu.
Note: DALI channel and DALI group folders are already linked to the corresponding DALI channel
or group. Thus, they do not require an assignment via the web-UI.
1. On the Web interface go to the menu Commission and select the DALI technology.
2. The Web UI lists all DALI devices found in the configuration in the Unassigned Devices
list (see Figure 207).
3. Press the Scan button found above the Scanned Devices not in Database section.
4. After the scan of the DALI channel was completed, the devices can be assigned as
described in the section DALI Installation in the LOYTEC Devices User Manual [1].
Assignment can be performed either using manual assignment (after devices were
identified either via winking or via physical selection) or via the DALI Device Search
Wizard.
Figure 209: Assigning DALI devices with manual assignment or using DALI Device Search Wizard.
16 Script Engine
16.1 Overview
The scripting feature on LOYTEC devices that provide it is based on a JavaScript engine and
follows a strict event-based model known from the node.js model. The script engine allows
users to implement custom protocols using RESTful APIs, JSON, Web services for IoT
integration into the LOYTEC data point model. The dpal-js API gives JavaScript modules
access to the data point server. Script modules are embedded into and deployed along with
the data point configuration.
The device firmware is able to run script modules in a separate process. Each script module
is based on a script resource that contains the JavaScript sources and other necessary files
and libraries. This concept is similar to constructing an npm package of the node package
manager (see www.npmjs.com).
Script folder: This represents a folder that contains a collection of files which
constitutes the script resource. Similar to an npm module a main file has to be
appointed. This can be implicit by naming convention (index.js or foldername.js) or
explicit by looking into the package.json. The script management dialog reveals the
main.js file in the expanded details as shown in Figure 210.
Once imported, the Configurator keeps track of changes to the script files on the source
location. In the development cycle they are typically edited by a JavaScript IDE. When
opening the dialog, it scans for newer files on the hard drive and marks them in the dialog as
new.
Script resources managed by this dialog are deployed to the device. Each script resource is
then instantiated on the device and executed by the script engine. Typically, a script resource
will look for certain data points in the configuration to link its internal data objects to data
points.
3. Click on the plus button and choose either script resource file or folder.
4. When editing the script files on the hard drive, the sync status will be refreshed and
displays new to indicate there is newer content not yet in the configuration.
5. To embed the latest changes, select the line and click on the Update content button
6. The script content will be downloaded to the device with the next data point
configuration download.
1. Under the Global Objects folder, select the Script Object Configuration sub-folder.
2. Right-click and select New Datapoint Script Object … from the context menu.
3. In the Create New Datapoint Script Object dialog enter a Name and optional
Description.
5. If the file script resource is valid the dialog shows the script’s variable references starting
v1, etc.
6. Select the variable line and click the button Attach DP… to attach a data point to the
script variable. Use Detach DP to remove a data point reference.
Refer to the example scripts uptime.js, on_change.js and weather.js to explore the basic data
point API usage. These script resources can be found in the script examples folder of the
Configurator program installation.
A script resource may also require other library modules. This can be accomplished by
creating a script folder resource and add custom libraries local to this folder in its own
‘node_modules’ sub-folder. This is compatible with installing npm modules locally in the
script resource folder.
This is an example: The folder resource ‘myProtocol’ requires the custom ‘express’ and
‘debug’ modules. This is done by installing the ‘express’ npm local to the ‘myProtocol’
folder. This library module will be placed into the ‘node_modules/express’ sub-folder along
with other dependent modules. An example is shown in Figure 212. The entire ‘myProtocol’
folder is then added as a folder resource to the Configurator.
The module exports the constructor function(dpReferences). Inside the constructor a data
point vector is created by calling dp.newVector(dpReferences). This vector contains the data
point access objects v[1], v[2], etc. as seen in the data point script object.
The module also needs to export a metaData object as shown in Figure 214. This object
describes the variables used in the script object and their required data point class (e.g. analog
or binary). This meta-data is evaluated by the Configurator when instantiating a new data
point script object.
16.4.4 Prototyping
Normally, script resources are deployed by the Configurator software. This is a streamlined
solution for the end user but not very practical when prototyping a script implementation. To
do a simple test of a script resource, the script files can be placed on the device as unmanaged
scripts.
Managed script resources are located in a sub-directory named just like the scope name, e.g.
“User” in ‘/var/lib/node_app/User’ on the device. This folder is managed by the Configurator
and its contents will be overwritten with each deployment. A prototype script can be placed
into the unmanaged folder ‘/var/lib/node_app/unmanaged’ using a file manager that can
transfer over SSH (e.g. WinSCP).
If no such tool is available or SSH is blocked by a firewall, one can use the transfer functions
of the script configuration Web interface (see Figure 215). The scripts need to be stopped
first.
Click the Upload button in the Upload unmanaged module section to load an unmanaged
script resource onto the device. If the script is a file resource, simply select the .js file. If the
script is a folder resource, you need to ZIP the folder first, then upload the .zip file. The folder
on the device is named after the .zip filename.
To retrieve the JavaScript code of a script resource from the Web interface, click on the save
to disk button of the desired module. To delete a script resource from the device click on
the delete button .
16.4.5 Debugging
Script resources on the LOYTEC device are automatically started when the device boots up.
In order to debug a script, it is necessary to stop the running scripts and start them in a debug
mode. This can be accomplished on the Web interface on the device. Use the Stop button as
indicated in Figure 216. Note that the console log persists till the next start.
To debug click the Debug button and wait till the script debugger URL for Google Chrome
is printed on the Web UI as shown in Figure 217.
Copy this URL to Google Chrome and wait for Chrome to connect. Then click the GO button
to start the script. Use Chrome DevTools debugging techniques as for Web pages. When
debugging it is useful to turn auto-respawn of scripts off. In this case the root cause of an
uncaught exception is easier to find. For doing so, deselect the check box Respawn scripts
when exited.
Another debugging technique is to use console.log() output and observe the output in the
node.js Web UI log window. An example is shown in Figure 218.
17 File Formats
After that line any number of comment lines starting with the hash character ‘#’ are allowed.
Lines that are not comments specify a data point to be modified or created, using the column
name as the respective data point property name. The most important properties are described
in Table 16. The columns are separated by commas ‘,’ or semi-colons ‘;’.
When importing a data point CSV file, each line is evaluated whether an edit or a create
operation shall be executed. An edit is done if a value in an identifier column (UID, IdPath)
exists. That value identifies an existing data point. The remaining columns are then written
to the respective properties of the data point.
If no data point is identified, the data point is created under the specified ‘Path’ and ‘Name’.
The path is relative to the location where the import was started (i.e. if the import was started
on the folder ‘User Registers.Room1’ then the path is relative to ‘User Registers.Room1’.
For creating a data point, additional property columns must be specified, depending on the
technology. The import result will be displayed in a log file, which states missing
information.
Alternatively, a data point template file (.dptmpl) may be specified in the ‘TemplateFile’
column, which contains all the information to create a data point of a given technology (e.g.,
a BACnet server object or a user register with an alarm condition). The file paths of the
referenced data point template XML files are relative to the location of the data point template
CSV file.
The data point CSV file may be further divided into sub-sections, which define the target
technology of the data points. A section is started with a comment line #target followed by
the data point root folder of that technology. For example, the CEA-709 section is started by:
#target: CEA-709 Port
All data point CSV lines following this comment are destined for the CEA-709 Port folder
and its sub-folders. This is especially important, if data points of multiple technologies shall
be created by a single data point CSV file. When importing from a different root folder, all
target sections of other root folders are skipped.
The first line of the file must contain a comment, starting with a hash character ‘#’ specifying
the format version and import technology:
#dpal_csv_config;Version=1;Technology=CEA709
After that line any number of comment lines starting with the hash character ‘#’ are allowed.
Lines that are not comments specify one NV per line, using the column information as
described in Table 17. The columns are separated by commas ‘,’ or semi-colons ‘;’. Which
separator is used can be configured in the system settings (see Section 4.3.3).
a. Bus: either “LIOB” or “LIOB-FT”. If the field in this column starts with “#”,
the whole line is ignored. This can be used e.g. for a column header line or other
comment lines in the CSV file.
b. Station ID: station ID of the L-IOB device (1-8) within the bus.
e. NID: specifies the Node ID of the device if already known. Otherwise, the field
is left blank.
h. Terminal Template: file name of the terminal configuration (which was stored
using Export object to disc ), e.g. “Humid_Sensor.xml”.
j. Favorite Name: optional name of a data point in the folder “Favorites”. If this
column entry exists for an I/O, an additional data point (input or output value)
in the “Favorites” folder of the L-IOB host will be created.
k. OPC: specifies if the Favorite data point shall be OPC exposed (‘true’) or not
(‘false’).
l. PLC In: specifies if the Favorite data point shall be exposed as a logic program
input data point (‘true’) or not (‘false’).
m. PLC Out: specifies if the Favorite data point shall be exposed as a logic program
output data point (‘true’) or not (‘false’).
18 Application Notes
19 References
20 Revision History
2016-03-23 6.0 STS Initial revision of the LINX Configurator User Manual.
2016-10-19 6.1 STS Updated for 6.1 release. Updated 4.2.3 Data Point List –
configure columns. Section 4.12.1: description on how to
remove historic filters. Updated Section 5.1.1 CEA-709
Settings. Added Section 5.4.7 Incremental Scans.
Updated Section 6.3.1 Scan for BACnet Objects by
incremental scan. Added Section 10.2.4 LSMI-804 and
power-on data points. Added Chapter 12 MP-Bus.
2017-04-24 6.2 STS Updated for 6.2 release. Section 3.1.9 Added Sun
Azimuth, Sun Elevation system registers. Section 3.4.6
specified tolerance interval for historic filters. Section
3.7.1 BACnet client supports unsolicited COV. Section
10.1.3 Document SNVT_setting behavior in SMI. Section
10.2.4 describe how to deactivate SMI power-off feature.
2017-12-20 6.3 JB, Updated for 6.3 release. Section 3.1.9 Documented
STS voltage reading with AC power. Section 4.8.3 Added
table on alarm state triggers. Chapter 15: DALI-2 support.
2018-05-15 6.4 STS, Updated for 6.4 release. Added Section 3.15.7 Run hours
JB for inputs. Documented calendar and scheduled event
limits in Sections 3.4.3, 3.6.4, 3.7.3. Updated Section
4.15.3 on digital interpretation of analog UI. Updated
Section 7.3 regarding multiple M-Bus ports. Updated
Section 8.2.1 Modbus device management dialog.
Updated Section 8.2.3 Online test for commission-later
devices. Added Chapter 16 Script engine. Added
description of DALI workflow for programmable
controllers. Added description of new DALI colour
picker.