Zenon Driver Manual
Zenon Driver Manual
Zenon Driver Manual
3S_32
v.8.10
© 2019 Ing. Punzenberger COPA-DATA GmbH
Distribution and/or reproduction of this document or parts thereof in any form are permitted solely with
the written permission of the company COPA-DATA. Technical data is only used for product description
and are not guaranteed qualities in the legal sense. Subject to change, technical or otherwise.
Contents
2 3S_32.............................................................................................................................................................. 4
5 Requirements .............................................................................................................................................. 7
5.1 PC ........................................................................................................................................................................... 7
6 Configuration .............................................................................................................................................. 7
6.1 Creating a driver ............................................................................................................................................... 8
6.2 Settings in the driver dialog .......................................................................................................................11
6.2.1 General ...................................................................................................................................................................... 12
6.2.2 Codesys parameters ............................................................................................................................................ 15
7 Creating variables..................................................................................................................................... 23
7.1 Creating variables in the Editor.................................................................................................................23
7.2 Addressing ........................................................................................................................................................27
7.3 Driver objects and datatypes .....................................................................................................................28
7.3.1 Driver objects ......................................................................................................................................................... 28
7.3.2 Mapping of the data types ............................................................................................................................... 29
7.4 Creating variables by importing ...............................................................................................................30
7.4.1 XML import ............................................................................................................................................................. 30
7.4.2 DBF Import/Export ............................................................................................................................................... 31
7.5 Communication details (Driver variables) .............................................................................................37
8 Driver-specific functions......................................................................................................................... 43
ZENON VIDEO-TUTORIALS
You can find practical examples for project configuration with zenon in our YouTube channel
(https://www.copadata.com/tutorial_menu). The tutorials are grouped according to topics and give an
initial insight into working with different zenon modules. All tutorials are available in English.
GENERAL HELP
If you cannot find any information you require in this help chapter or can think of anything that you
would like added, please send an email to documentation@copadata.com.
PROJECT SUPPORT
You can receive support for any real project you may have from our Support Team, who you can
contact via email at support@copadata.com.
2 3S_32
Information
This driver will be superseded from zenon 7.50 by 3S_V3. Please only use the
3S_V3 driver for new projects.
4 | 50
3S_32 - data sheet
PLC types Codesys Soft PLC, Elau Max 4 and Moeller XControl PLCs XC100,
XC200 and XC600
Driver supports:
Protocol 3S-Gateway
Addressing: Name-based --
Spontaneous --
communication
Polling communication X
Online browsing X
Offline browsing --
Real-time capable --
Blockwrite --
Modem capable --
RDA numerical --
RDA String --
Hysteresis --
extended API --
alternative IP address --
5 | 50
Driver history
Requirements:
Hardware PLC --
Software PLC Codesys Gateway Server from version 2.2.5, Codesys SP RTE
Runtime
Requires v-dll --
Platforms:
4 Driver history
Date Driver version Change
DRIVER VERSIONING
The versioning of the drivers was changed with zenon 7.10. There is a cross-version build number as of
this version. This is the number in the 4th position of the file version,
For example: 7.10.0.4228 means: The driver is for version 7.10 service pack 0, and has the build number
4228.
Expansions or error rectifications will be incorporated into a build in the future and are then available
from the next consecutive build number.
6 | 50
Requirements
Example
A driver extension was implemented in build 4228. The driver that you are using
is build number 8322. Because the build number of your driver is higher than
the build number of the extension, the extension is included. The version
number of the driver (the first three digits of the file version) do not have any
significance in relation to this. The drivers are version-agnostic
5 Requirements
This chapter contains information on the requirements that are necessary for use of this driver.
5.1 PC
SOFTWARE
Codesys version 2.x has to be installed on the PC.
Codesys Gateway Server version 2.x and Hotfix (November 6th, 2002) has to be installed on the
zenon Editor PC and on the PC, where the Codesys Runtime is running.
Information
The 3s_32 driver supports only connections to Codesys version 2.x.
Codesys version 3.x or higher is not supported. Please use therefore the 3S_V3
driver.
6 Configuration
In this chapter you will learn how to use the driver in a project and which settings you can change.
Information
Find out more about further settings for zenon variables in the chapter Variables
(main.chm::/15247.htm) of the online manual.
7 | 50
Configuration
Parameter Description
Default: no selection
Default: Empty
The input field is pre-filled with the pre-defined
Identification after selecting a driver from the list
of available drivers.
8 | 50
Configuration
Parameter Description
Default: Empty
The information on the selected driver is shown in
this area after selecting a driver.
CLOSE DIALOG
Option Description
Information
The content of this dialog is saved in the file called Treiber_[Language].xml. You
can find this file in the following folder:
C:\ProgramData\COPA-DATA\zenon[version number].
9 | 50
Configuration
3. Select the desired driver and name it in the Driver name input field.
This input field corresponds to the Identification property. The name of the selected driver is
automatically inserted into this input field by default.
The following is applicable for the Driver name:
The Driver name must be unique.
If a driver is used more than once in a project, a new name has to be given each time.
This is evaluated by clicking on the OK button. If the driver is already present in the project,
this is shown with a warning dialog.
The Driver name is part of the file name.
Therefore it may only contain characters which are supported by the operating system.
Invalid characters are replaced by an underscore (_).
Attention: This name cannot be changed later on.
4. Confirm the dialog by clicking on the OK button.
The configuration dialog for the selected driver is opened.
Note: The language of driver names cannot be switched. They are always shown in the language in
which they have been created, regardless of the language of the Editor. This also applies to driver object
types.
10 | 50
Configuration
If there is already a driver in the project, this is shown in a dialog. The warning dialog is closed by
clicking on the OK button. The driver can be named correctly.
ZENON PROJECT
Information
Only the required drivers need to be present in a zenon project. Drivers can be
added at a later time if required.
11 | 50
Configuration
6.2.1 General
The configuration dialog is opened when a driver is created. In order to be able to open the dialog later
for editing, double click on the driver in the list or click on the Configuration property.
Option Description
12 | 50
Configuration
Option Description
within a value range automatically.
Simulation - programmed:
No communication is established to the PLC. The
values are calculated by a freely programmable
simulation project. The simulation project is created
with the help of the zenon Logic Workbench and
runs in a zenon Logic Runtime which is integrated
in the driver.
For details see chapter Driver simulation
(main.chm::/25206.htm).
Keep update list in the memory Variables which were requested once are still requested
from the control even if they are currently not needed.
This has the advantage that e.g. multiple screen switches
after the screen was opened for the first time are
executed faster because the variables need not be
requested again. The disadvantage is a higher load for the
communication to the control.
Variable image remanent This option saves and restores the current value, time
stamp and the states of a data point.
13 | 50
Configuration
Option Description
programmed simulation)
Stop on Standby Server Setting for redundancy at drivers which allow only one
communication connection. For this the driver is stopped
at the Standby Server and only started at the upgrade.
Default: inactive
Global Update time Setting for the global update times in milliseconds:
Active:
The set Global update time is used for all
variables in the project. The priority set at the
variables is not used.
Inactive:
The set priorities are used for the individual
variables.
14 | 50
Configuration
Option Description
Priority The polling times for the individual priority classes are set
here. All variables with the according priority are polled in
the set time.
CLOSE DIALOG
Option Description
OK Applies all changes in all tabs and closes the dialog.
Cancel Discards all changes in all tabs and closes the dialog.
Spontaneous drivers are ArchDrv, BiffiDCM, BrTcp32, DNP3, Esser32, FipDrv32, FpcDrv32, IEC850,
IEC870, IEC870_103, Otis, RTK9000, S7DCOS, SAIA_Slave, STRATON32 and Trend32.
15 | 50
Configuration
Ensure that the necessary CodeSys requirements (on page 7) have been met.
Parameter Description
Default: inactive
16 | 50
Configuration
SCADA variable list List of all variables available with the PLC runtime:
Name:
Variable name, as configured on the PLC.
Type:
Data type of the variable, as configured on
the PLC.
Adress:
Net address of the variable, as configured
on the PLC.
17 | 50
Configuration
CLOSE DIALOG
Options Description
OK Applies settings and closes the dialog.
The Codesys gateway server is also started after the driver dialog is called up. If the requirements for
communication are not met, the driver configuration is blocked for a long period of time. An error
message is shown once this time period has expired.
This error dialog and the resultant waiting time also occurs in the dialog
18 | 50
Configuration
This file has to be copied to the project directory of the server with Remote Transport!
CHANNELS
Visualization of the current communication connections. This view is in a list view of all connections and
subdivided into a detail view of the respective selected connection parameters.
Parameter Description
19 | 50
Configuration
Parameter Description
of the connection parameters in the main window.
Clicking on [+] expands the list view of all
configured connections.
Clicking on [-] with the list expanded
reduces the view in the structure tree.
BUTTONS
Parameter Description
20 | 50
Configuration
Parameter Description
Reload
Information
If the PLC Runtime is running on the server and the project is loaded, the
Codesys project name is also displayed in the Gateway list node.
This file has to be copied to the project directory of the server with Remote Transport!
21 | 50
Configuration
Parameter Description
Device
Parameter Description
Default:Local
22 | 50
Creating variables
Parameter Description
Default:1210
CLOSE DIALOG
OK Applies all changes in all tabs and closes the dialog.
Cancel Discards all changes in all tabs and closes the dialog.
7 Creating variables
This is how you can create variables in the zenon Editor:
VARIABLE DIALOG
To create a new variable, regardless of which type:
23 | 50
Creating variables
1. Select the New variable command in the Variables node in the context menu
24 | 50
Creating variables
Property Description
Name Distinct name of the variable. If a variable with the same name
already exists in the project, no additional variable can be created
with this name.
Note: If no driver has been opened in the project, the driver for
internal variables (Intern.exe (Main.chm::/Intern.chm::/Intern.htm))
is automatically loaded.
Driver Object Type Select the appropriate driver object type from the drop-down list.
(cti.chm::/28685.htm)
Data Type Select the desired data type. Click on the ... button to open the
25 | 50
Creating variables
Property Description
selection dialog.
Array settings Expanded settings for array variables. You can find details in the
Arrays chapter.
Addressing options Expanded settings for arrays and structure variables. You can find
details in the respective section.
Automatic addressing Expanded settings for arrays and structure variables. You can find
details in the respective section.
SYMBOLIC ADDRESS
The Symbolic address property can be used for addressing as an alternative to the Name or
Identification of the variables. Selection is made in the driver dialog; configuration is carried out in the
variable property. When importing variables of supported drivers, the property is entered automatically.
26 | 50
Creating variables
Note for signal range: If a change is made to a data type that does not support the set signal
range, the signal range is amended automatically. For example, for a change from INT to SINT, the
signal range is changed to 127. The amendment is also carried out if the signal range was not
inherited from the data type. In this case, the measuring range must be adapted manually.
7.2 Addressing
Property Description
Data block For variables of object type Extended data block, enter the datablock
number here.
You can take the exact maximum area for data blocks from the manual of
the PLC.
Offset Offset of variables. Equal to the memory address of the variable in the PLC.
Adjustable from 0 to 4294967295.
Driver Object type of the variables. Depending on the driver used, is selected
connection/Driver when the variable is created and can be changed here.
Object Type
Driver Data type of the variable. Is selected during the creation of the variable;
connection/Data the type can be changed here.
Type
Attention: If you change the data type later, all other properties of the
variable must be checked and adjusted, if necessary.
27 | 50
Creating variables
Property Description
Driver
connection/Priorit
y
28 | 50
Creating variables
Configuration
Key:
X: supported
DT Not supported
29 | 50
Creating variables
DATA TYPE
The term data type is the internal numerical identification of the data type. It is also used for the
extended DBF import/export of the variables.
Information
You can find details on the import and export of variables in the Import-Export
(main.chm::/13028.htm) manual in the Variables (main.chm::/13045.htm) section.
30 | 50
Creating variables
Import:
The element is imported as a new element.
Overwrite:
The element is imported and overwrites a pre-existing element.
Do not import:
The element is not imported.
Note: The actions and their durations are shown in a progress bar during import. The import of
variables is described in the following documentation. Data types are imported along the same lines.
REQUIREMENTS
The following conditions are applicable during import:
Backward compatibility
At the XML import/export there is no backward compatibility. Data from older zenon versions
can be taken over. The handover of data from newer to older versions is not supported.
Consistency
The XML file to be imported has to be consistent. There is no plausibility check on importing
the file. If there are errors in the import file, this can lead to undesirable effects in the project.
Particular attention must be paid to this, primarily if not all properties exist in the XML file and
these are then filled with default values. E.g.: A binary variable has a limit value of 300.
Structure data types
Structure data types must have the same number of structure elements.
Example: A structure data type in the project has 3 structure elements. A data type with the
same name in the XML file has 4 structure elements. Then none of the variables based on this
data type in the file are imported into the project.
Hint
You can find further information on XML import in the Import - Export manual,
in the XML import (main.chm::/13046.htm) chapter.
31 | 50
Creating variables
Information
Import and Export via CSV or dBase supported; no driver specific variable
settings, such as formulas. Use export/import via XML for this.
Information
Note:
Driver object type and data type must be amended to the target driver in
the DBF file in order for variables to be imported.
dBase does not support structures or arrays (complex variables) at import.
Attention
DBF files:
must correspond to the 8.3 DOS format for filenames (8 alphanumeric
characters for name, 3 character suffix, no spaces)
must not have dots (.) in the path name.
e.g. the path C:\users\John.Smith\test.dbf is invalid.
Valid: C:\users\JohnSmith\test.dbf
must be stored close to the root directory in order to fulfill the limit for file
name length including path: maximum 255 characters
32 | 50
Creating variables
Information
dBase does not support structures or arrays (complex variables) at export.
Attention
dBase does not support structures or arrays (complex variables) at export.
STRUCTURE
Identification Typ Field size Comment
e
KANAL_D Log 1 The variable is deleted with the 1 entry (field/column has
to be created by hand).
DATENART C 3 Data type (e.g. bit, byte, word, ...) corresponds to the
33 | 50
Creating variables
KANALTYP C 3 Memory area in the PLC (e.g. marker area, data area, ...)
corresponds to the driver object type.
BAUSTEIN N 3 Datablock address (only for variables from the data area
of the PLC)
ADRESSE N 5 Offset
LES_SCHR L 1 Write-Read-Authorization
0: Not allowed to set value.
1: Allowed to set value.
34 | 50
Creating variables
HDRATE F 19 HD update rate for historical values (in sec, one decimal
possible)
VOMSTANDBY R 1 Get value from standby server; the value of the variable
is not requested from the server but from the Standby
Server in redundant networks
ADJZENON C 128 Linked VBA macro for reading the variable value for
non-linear value adjustment.
ADJWVBA C 128 ed VBA macro for writing the variable value for
non-linear value adjustment.
35 | 50
Creating variables
Attention
When importing, the driver object type and data type must be amended to the
target driver in the DBF file in order for variables to be imported.
ALARM1 R 1 Alarm
36 | 50
Creating variables
INVISIBLE1 R 1 Invisible
Expressions in the column "Comment" refer to the expressions used in the dialog boxes for the
definition of variables. For more information, see chapter Variable definition.
The definitions of the variables implemented in the driver kit are available in the import file DRVVAR.DBF
and can be imported from there.
Path to file: %ProgramData%\COPA-DATA\zenon<Versionsnummer>\PredefinedVariables
Note: Variable names must be unique in zenon. If driver variables of the driver object type
Communication details are to be imported from DRVVAR.DBF again, the variables that were imported
beforehand must be renamed.
Information
Not every driver supports all driver variables of the driver object type
Communication details.
For example:
Variables for modem information are only supported by
37 | 50
Creating variables
modem-compatible drivers.
Driver variables for the polling cycle are only available for pure polling
drivers.
Connection-related information such as ErrorMSG is only supported for
drivers that only edit one connection at a a time.
INFORMATION
Name from import Type Offset Description
38 | 50
Creating variables
Connection statuses:
0: Connection OK
1: Connection failure
2: Connection simulated
Formating:
<Netzadresse>:<Verbindungszustand>;…;…;
39 | 50
Creating variables
CONFIGURATION
Name from import Type Offset Description
40 | 50
Creating variables
STATISTICS
Name from import Type Offse Description
t
41 | 50
Creating variables
MaxUpdateTimeNormal UDINT 56 Time since the last update of the priority group
Normal in milliseconds (ms).
MaxUpdateTimeHigher UDINT 57 Time since the last update of the priority group
Higher in milliseconds (ms).
MaxUpdateTimeHigh UDINT 58 Time since the last update of the priority group
High in milliseconds (ms).
MaxUpdateTimeHighest UDINT 59 Time since the last update of the priority group
Highest in milliseconds (ms).
ERROR MESSAGE
Name from import Type Offse Description
t
ErrorTimeDW UDINT 2 Time (in seconds since 1.1.1970), when the last error
occurred.
ErrorTimeS STRING 2 Time (in seconds since 1.1.1970), when the last error
occurred.
RdErrStationsName STRING 43 Name of the station, when the last reading error
occurred.
RdErrBlockCount UINT 44 Number of blocks to read when the last reading error
occurred.
42 | 50
Driver-specific functions
RdErrDatablockNo UDINT 46 Block number when the last reading error occurred.
RdErrMarkerNo UDINT 47 Marker number when the last reading error occurred.
RdErrSize UDINT 48 Block size when the last reading error occurred.
8 Driver-specific functions
The driver supports the following functions:
LIMITATIONS
Adding the variables from the PLC in the driver configuration creates a file in the project directory on
the PC: [PROJECTNAME]_Codesys.cmp . This will not be renamed when renaming the project! This data
name has to be renamed manually with the new project name. Otherwise, the link to the variables will
not be found anymore. A communication is not possible anymore in this case.
43 | 50
Driver command function
Note: This chapter describes standard functions that are valid for most zenon drivers.
Not all functions described here are available for every driver. For example, a driver that does not,
according to the data sheet, support a modem connection also does not have any modem functions.
Attention
The zenon Driver commands function is not identical to driver commands that
can be executed in the Runtime with Energy drivers!
44 | 50
Driver command function
Option Description
45 | 50
Driver command function
Option Description
Show this dialog in the Runtime Configuration of whether the configuration can be
changed in the Runtime:
Active: This dialog is opened in the Runtime
before executing the function. The configuration
can thus still be changed in the Runtime before
execution.
Inactive: The Editor configuration is applied in the
Runtime when executing the function.
Default: inactive
CLOSE DIALOG
Options Description
OK Applies settings and closes the dialog.
46 | 50
Driver command function
Activate driver write set value Write set value to a driver is possible.
Deactivate driver write set value Write set value to a driver is prohibited.
Opens the input fields for the hardware address and for
the telephone number.
Driver in counting simulation mode Driver is set into counting simulation mode.
All values are initialized with 0 and incremented in the
set update time by 1 each time up to the maximum
value and then start at 0 again.
47 | 50
Error analysis
This makes sure that Server and Standby are synchronized. This only works if the Server and the Standby
both have a working and independent connection to the hardware.
10 Error analysis
Should there be communication problems, this chapter will assist you in finding out the error.
zenon driver log all errors in the LOG files.LOG files are text files with a special structure. The default
folder for the LOG files is subfolder LOG in the folder ProgramData. For example:
%ProgramData%\COPA-DATA\LOG.
Attention: With the default settings, a driver only logs error information. With the Diagnosis Viewer
you can enhance the diagnosis level for most of the drivers to "Debug" and "Deep Debug". With this the
driver also logs all other important tasks and events.
Note:
1. The Diagnosis Viewer displays all entries in UTC (coordinated world time) and not in local time.
2. The Diagnosis Viewer does not display all columns of a LOG file per default. To display more
columns activate property Add all columns with entry in the context menu of the column
header.
3. If you only use Error-Logging, the problem description is in the column Error text. For other
diagnosis level the description is in the column General text.
4. For communication problems many drivers also log error numbers which the PLC assigns to
them. They are displayed in Error text or Error code or Driver error parameter (1 and 2). Hints on
the meaning of error codes can be found in the driver documentation and the protocol/PLC
description.
5. At the end of your test set back the diagnosis level from Debug or Deep Debug. At Debug and
Deep Debug there are a great deal of data for logging which are saved to the hard drive and
48 | 50
Error analysis
which can influence your system performance. They are still logged even after you close the
Diagnosis Viewer.
Attention
In Windows CE errors are not logged per default due to performance reasons.
You can find further information on the Diagnosis Viewer in the Diagnose Viewer
(main.chm::/12464.htm) manual.
Information
Please do not read out the PLC or add any variables until you have copied the
old variable file!
On converting projects in the actual version, the variable file <projectname>_codesys.cmp is not copied
to the new project directory.
The driver does not have any mechanism in order to recopy this file. Hence, there are no existing
variable links anymore after converting. The file <projektname>_codesys.cmp must be manually copied
to \ED\FILES\zenon\custom\drivers and renamed to Codesys.cmp. before converting.
49 | 50
Error analysis
Only one driver of type 3S_32 can be used in the project. Only a *.cmp file is possible through the set
(predefined) name.
50 | 50