advertisement
eWON Family
Primary Range
500, 2001, 2005, 2101, 4001, 4002, 4005, 4101, 4102
* * *
Compact Design Range
2001CD, 2005CD, 2101CD, 4001CD, 4005CD, 4101CD
* * *
Flexy Range
Flexy 101, 102 & 103 and Flexy 201, 202 & 203
General Reference Guide
rev. 2.1
RG-001-1-EN-(General Reference Guide) eWON® - 14/01/2014 - ©eWON sa Page 1
Table of content
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 2
Table of content
5.10.2 Standard eWON I/O Item Names ........................................................... 134
5.12 S7-300&400 (MPI/Profibus - ISOTCP) ...................................................... 144
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 3
Table of content
5.17 MITSUBISHI MELSEC IO Server ............................................................... 169
7.2.1 Config.txt : New Line character (NLSeparator) ......................................... 193
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 4
Table of content
9.3 Upgrading the eWON firmware by a direct upload ....................................... 223
9.6 Upgrade Bootloader (to upgrade to firmware >= 5.2) ................................... 230
10.1 Access to the eWON Technical Support .................................................... 231
10.5 Table of comparison between eWON types ............................................... 234
10.6 Duplicate IP detection (User Led blinking Red) .......................................... 236
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 5
Table of content
10.9 SMS Character set GSM 03.38 ............................................................... 238
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 6
General Reference Guide Introduction
1 Introduction
The aim of this guide is to provide you exhaustive information about the multiple eWON firmware features.
This guide describes the features of firmware version 7.0 for all the eWON types. You will find in this guide some references to a matrix table which you can find at the end of this guide. The matrix table allows you to check if the described feature is available on your eWON type or not.
Please refer to chapter “Table of comparison between eWON types” on page 234.
Users who prefer to consult the printed manual should keep a printed copy of the eWON's comparison table apart from the entire guide to quickly check the different features that are available or not, depending on the type of eWON they are working with.
Now let's discover all the possibilities offered by your eWON on a daily basis.
Firmware 7.0: added features
• Alarm Notification Templates Feature allowing to customize the contents of emails and SMS triggered by alarms
• Mitsubishi FX3U- and A-Series Allows to poll variables from these models
• WAN failover mechanism
Firmware 6.4: added features
Feature enabling to trigger an access by GPRS modem if the WAN connection is down
• eWON COSY support
• Tabular configuration editor
Features the simplified web interface of the eWON COSY
Allows to configure the eWON using the “Tabular config editor” on page 76
Firmware 6.3: added features
• New Melsec IOserver Allows to poll data on Mitsubishi Q series
• Advanced MPI/Profibus routing Allows to reach MPI/Profibus networks behind the first connected network
see “Advanced Routing Setup” on page 146
• GSM Modem improvements It is now possible to force the modem to connect to 3G or 2G network.
see “Modem configuration (GSM/GPRS modem)” on page 33
Firmware 6.2: added features
• NAT on LAN (Plug’n Route) The NAT & TF feature is now available also for the LAN
• VPN Protection VPN addresses can be filtered to allow only some specific access to eWON or LAN Devices
• PIN code of any size are now accepted
Firmware 6.0: added features
• New DataType Tag: DWORD (unsigned 32bits) and INTEGER (signed 32bits).
see “DataType of Tags” on page 79
• Tag Quality:
• eBuddy security:
Change the IP address by eBuddy requires authentication, see “Security” on page 71
• DataManagement: support of eSyncDM, see “Data Management” on page 25
Firmware 5.7: added features
• Task Planner
Firmware 5.6s2: added features
• SNMP IO Server
Firmware 5.5: added features
• MITSUBISHI IO Server
• PPI Multi-Master
• ENDIAN server support
Firmware 5.4: added features
• DHCP
• ADSL
• More Dynamic DNS poviders available
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 7
General Reference Guide
• Web interface: Modem + Internet connection Wizards
GSM operator selection + antenna Level displayed on led
ISDN: MSN definition
• HITACHI IO Server
Introduction
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 8
General Reference Guide
2 The eWON login page
2.1 Access from a Computer Browser
When you connect to the eWON with Internet Explorer, you will be invited to log you on.
Introduction
Figure 1: eWON login page
The factory predefined parameters to login on the eWON are:
IP address
Login
Password
10.0.0.53
adm
adm
Table 1: eWON default login parameters
IMPORTANT! Password IS case sensitive but user name is not.
It is recommended to change the password of the "adm" user to protect it against any intrusion. You will be able to change the user configuration in the Users setup screen of your eWON (please refer to chapter “Users Setup” on page 8).
Note: On eWONs featuring a multiple language firmware (ex. Flexy), the language selection popup appears after the first login (or after a reset level 2). Changing the language afterward can be done preferably by doing a reset level 2 or, if a reset cannot be done, by changing the parameter Language in the comcfg.txt file that can be accessed through the path: Configuration > System setup > Storage > Tabular Edition
> Edit COM cfg. Set the Language parameter to -1 (minus one). After reboot, the language popup will show and you can do your selection.
Whatever the method used to change the language, the eWON needs a reboot to take the change into account. This reboot can be done either by powering OFF and ON again or by software following the path: Configuration > System setup > General > General > Reboot.
2.2 Access from a PDA Browser
The default Website of eWON is designed to be viewed on a PC Browser.
In order to provide an access to the PDA home page, the full URL: http://ewon_ip/indexpda.htm must be entered.
If the eWON is only supposed to be connected from PDA, the default home page (see “User defined home page” on page 13) can also be changed.
RG-001-1-EN rev. 2.1
Figure 2: PDA Website
eWON® - 14/01/2014 - ©eWON sa Page 9
General Reference Guide
3 eWON Configuration Interface
Just after you have logged in successfully, the eWON Web Interface will be displayed. eWON Configuration
Figure 3: eWON interface page
But before analyzing the Monitoring Web Interfaces page, you need to configure your eWON.
Click on the Configuration menu item. The following Configuration web page then appears:
Figure 4: eWON configuration links
3.1 Overview
The Configuration menu includes the following points:
• User’s list
The user’s list is used by the eWON to restrict access to the various features of the eWON according to the user’s rights. It also allows logging the user’s actions (like alarm acknowledge…).
See also chapter "Users Setup" on page 8
• Tags list
The eWON monitors and manages variables (called Tags). A Tag can be Boolean or float, and Tags are produced by IO servers. The configuration of a Tag defines its IO server and all its monitoring parameters (historical logging (Warning: not for all eWONs
versions - see table page 234), alarm levels, etc.
See also chapter "Tag definition: Introduction" on page 79
• System configuration
Communication and global configuration of the eWON are defined here.
See also chapter "System Setup" on page 12
• IO Server configuration
the physical eWON IO or the Modbus remote IO, etc. Some of these IO servers require some configuration.
See also chapter "IO servers setup" on page 92
• Pages definitions
It is possible to organize the Tags by groups. These groups are called "pages" and they help keep a clearer organization of the
Tags and also manage per user rights for the Tags. Two pages, called "Default" and "System" are automatically defined, and up to
10 pages can be user defined.
See also chapter "Pages configuration" on page 92
• Scripts Configuration
The Basic language that is embedded in the eWON allows you to create your own scripts that you will use to get access to the data that are stored in the eWON, in order to perform real-time monitoring or programming actions on alarms,...
See also chapter "Script Setup" on page 93
• Wizards
Some wizards are availables to help you quickly configure some eWON features.
See also chapter
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 10
General Reference Guide
3.2 Users Setup
The Users Setup page allows building the list of authorized eWON users.
eWON Configuration
Figure 5: eWON Users Setup page
The user’s page lists all the eWON users and attributes. The first time that you connect to the eWON, the default user is Adm. It is recommended to modify the default password of the Administrator user.
3.2.1
To edit a user
Click on the user's name link in the User Login column.
3.2.2
To create a new user
Click on the Create New user link.
In both cases, you will get the following edit window:
Figure 6: eWON user's configuration page
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 11
General Reference Guide eWON Configuration
3.2.3
Logon parameters
First Name and Last Name are detailed (and optional) information about the user, while User Login and Password are mandatory (they are used during the logon procedure).
Logon procedures using the User Login and Password are:
• Main eWON access logon
• FTP server access
• User defined page Basic Access authentication (please refer to chapter "eWON identification" on page 13)
• PPP Dial up connection
Warning: depending on the eWON's version (c.f. table at the end of this manual page 234)
The same user name and password will be used for the different access.
3.2.4
User's rights
The following rights can be selected for user:
View IO
Force outputs
Acknowledge alarms
Change configuration
FTP server access eWON File access [EBD]
Java Forms access
Control Java JVM
Figure 7: User Rights
allows accessing the SCADA real time IO screen allows changing the eWON outputs allows acknowledging alarm allows accessing the configuration part of the eWON allow this UserName/Password to be used to access the eWON FTP Server allows accessing the File Transfer page.
allow this UserName/Password to be used to retrieve eWON Files (containing Export
Block Descriptor) with HTTP request using
/rcgi.bin/ParamForm?AST_Param=$$...EBD... allows accessing the Java Forms allows this user to control the Java JVM
Table 2: user’s rights explanations
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 12
General Reference Guide eWON Configuration
3.2.5
User’s directory restriction
When the user web site is built, HTML (or SHTM) pages can be placed in subdirectories. The root directory of the user defined web site is /usr
(from the FTP directory structure). Every user has access to that directory.
/usr is considered as DEFAULT directory for the web site.
For this explanation, assume that the following FTP directory structure is defined:
/usr/System contains pages for system administration
/usr/Update contains HTML files to update Tags
explanation the following pages have been defined:
Page 2
Page 3
When editing users rights, the following list would be proposed:
System
Update
The following security schemes would be possible:
Dir. Right selected
All
Default
System
Update
Access description
HTML Pages in any directory will be accessible.
Only the /usr directory pages will be accessible.
/usr and /System directory pages will be accessible.
Note: this is obviously not useful because /usr/Update will not be accessible which is probably not what is required for an "administrator". In the "administrator" case, the best selection is probably "All".
/usr and /usr/Update directory pages will be accessible.
Note:
/usr is always accessible.
When a subdirectory is accessible, all its subdirectories are accessible as well.
Example: /usr/Update/image would also be accessible.
Table 3: user’s security schemes - 1
The proposed directories list is derived from the PAGES LIST. It is of the user's responsibility to create the same pages as the directories in the
FTP structure (otherwise security setup will not be possible).
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 13
General Reference Guide eWON Configuration
3.2.6
Tag pages restriction
follows the below rules:
• User has always access to the "Default" page
• User can have access to all pages
• User can have access to only 1 page
Example: taking the same pages as in the previous example, the following selection box appears:
The following security schemes would be possible:
Page Right selected
All
Default
Update
System
Access description
Access to all Tag pages is granted.
Only the "Default" page is accessible.
"Default" and "Update" pages would be accessible.
"Default" and "System" pages would be accessible.
Table 4: user’s security schemes - 2
3.2.7
To delete a user
Click on the check box just next to the user's login of the user that you want to delete and click on the Delete Selected Users link.
• Note 1: you can select for deletion more than one user at the same time
• Note 2: the Adm user won’t be deleted (but you can rename it)
• Note 3: password is CASE SENSITIVE
3.2.8
Callback settings
Warning: depending on the eWON's version (c.f. Table 198 on page 209)
When the callback is enabled as a global parameter in the COM Setup page, the user can initiate a User’s callback and specify when the trigger will be started for the callback.
The callback phone number can be forced (from this menu), then the user can only initiate a call to a fixed phone number; or User Defined, then he can modify the phone number. In the first case, the list box is set to Mandatory, and in the second case, it is set to User Defined.
The callback phone number can be specified here. Remember that the user’s login and password that have been defined for the eWON access are used as login and password on the remote server called for callback.
Figure 8: User’s callback settings
3.2.9
Validation of the User's settings
When all the required fields are filled in, you can either click on the Add/Update button (to validate your changes) or on the Cancel button (to undo your changes).
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 14
General Reference Guide eWON Configuration
3.3 System Setup
The system setup page (accessed by clicking on the System Setup item from the configuration menu) allows to set all the eWON system parameters and looks as follows:
Figure 9: eWON system configuration page
This section has a high impact on the eWON behavior (mainly from a communication point of view). You should fill it in carefully.
The System setup page is divided in three sections:
• The Main system setup (General)
Defines all the eWON global settings, except for settings regarding the eWON communication. The user can modify the Email, FTP and NTP parameters, along with reboot.
• The Communication setup section
Includes all the communication settings of the eWON. These settings are separated from the Main settings and even stored at a different place inside the device in order to be able to format the eWON flash file system without affecting the communication settings (see also chapter "eWON configuration and files storage" on page 220. A menu allows the user to reset the communication parameters to their default values.
• The storage setup section
Used to set up the way the memory resources from the eWON are used.
3.3.1
General system setup
The General system page was presented by a tree with icons (see below).
Firmware 6
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 15
3.3.1.1
eWON identification
General Reference Guide eWON Configuration
Figure 10: eWON system general setup – eWON identification
Control eWON Identification
General Information
User defined home page
Enable user page security
Description
The name of the eWON. This information is added in each eWON e-mail alarm notification. Check that this identification and the next one allow you to identify your eWON without any doubt.
As for the eWON identification, you can put a free text. But it can be very useful to indicate here the eWON geographical location and phone number.
When a user defined web site is used, the home page of the eWON web site can be replaced by a user defined web page. If your default home page is a viewON synopsis, you need to select "viewON synopsis" in the Combo box and enter the name of the synopsis in the Text box.
If your default home page is a classical HTML page, you need to select "http://your_device_ip/usr" in the Combo box and enter the name of the page in the Text box.
If a user web site is defined, then default user logon page is not displayed and there is no session, but using Basic Authentication can also ensure security. This checkbox will enable the security when the user wants to access a user-defined page.
Table 5: eWON Identification controls
After having encoded your parameters, go to the bottom of the page to .
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 16
3.3.1.2
Alarms (generic parameters)
General Reference Guide eWON Configuration
Figure 11: eWON system general setup – Alarms
Control
Action retrig interval
Retry action
Action retry interval
Email Alarm Template
SMS Alarm Template
Description
The alarm action (eMail, SMS, PutFTP, trap SNMP) is retriggered permanently after specified interval as long as the alarm state is ALM (the retrig is stopped by an Acknowledge or a ReturnToNormal).
The default value for this parameter is 86400 seconds (1 day).
The value 0 disable the retriggering feature.
This parameter defines the number of times the action will be retried in case of errors. The value of this number must be greater than 1.
This parameter defines the interval (in seconds) between two retry attempts if an error occurs. The value for this parameter must be greater than 10.
Field where both free text AND functions can be introduced to customize the contents of the emails used during alarm notifications. The default email layout is ignored as soon as a single character is present in this field. The template will be applied to the alarm notification of all tags. Note: The template is not applied if the checkbox
Format as Short Message is selected for the email notification. That’s why this function is not available if SMS are sent using the Talk2M email notification service.
Field where both free text AND functions can be introduced to customize the contents of the SMS. The default
SMS layout is ignored as soon as a single character is present in this field. The template will be applied to the alarm notification of all tags.
Table 6: global alarms controls
After having encoded your parameters, go to the bottom of the page to .
3.3.1.3
Date & time
Figure 12: eWON system Date & time setup
The eWON’s real time clock can be updated manually with this dialog window. Fill in the edit box with date and time and click on .
An event will be added to the event log indicating the time update and the time offset between old and new time.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 17
General Reference Guide eWON Configuration
Important: Updating the time may result in duplicate points stored in non-chronological order in the eWON files (alarms, events and historical).
3.3.1.4
Reboot
Rebooting eWON is sometimes necessary (i.e. to validate some configuration changes).
Figure 13: eWON system Reboot
eWON version 5 offers three ways to perform a reboot:
• From the Reboot menu from General configuration page
• By using the "REBOOT" Basic command (see eWON programming Manual).
• From the Reboot menu from Storage configuration menu (on page 78)
You will have to wait that the eWON comes back to its normal state after restarting to get access to it again.
Some special operation like "Upgrade the firmware of the Modem" requires a reboot with the BootOp parameter set to a specific value. Use the
Special operation field to select the BootOperation to do. Now, only the Modem Upgrade value is available.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 18
General Reference Guide
3.3.1.5
Task Planner
Since Firmware 5.7, you can use this Task Planner to do some actions at fixed time or fixed interval.
These actions are the same as Tag Alarm actions, and are:
• Send an eMail
• Send a SMS
• Put a file on a FTP server
• Send a SNMP Trap
eWON Configuration
Control
Try action
Action retry interval
Timer Interval
Type of Actions
Edit
Force
Last Run
Figure 14: eWON Task Planner
Description
Global parameters
This parameter defines the number of times the action will be retried in case of errors.
The default value is 0.
This parameter defines the interval between two actions attempts if an error occurs. The value for this parameter must be greater than 10.
Planner configuration table
Defines when the action will be executed.
The syntax is the following:
mm hh dd MMM DDD
The action will be triggered when the time of the eWON matches the 5 parameters.
See "Timer Interval settings" on page 17
Information about the types of Action defined on this Entry.
Will be one or several info amongst EMAIL, SMS, FTP or TRAP.
Click on the Edit Button to open the Edit Action Page.
Click on the Force Button to force the execution of the configured Action(s).
Time information about the last execution of the Action(s).
Table 7: Task Planner parameters
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 19
General Reference Guide eWON Configuration
3.3.1.5.1
Timer Interval settings
The syntax is the following: mm hh dd MMM DDD
Field mm hh dd
MMM
DDD
Settings
This is the Minute parameter.
A number between 0 to 59
This is the Hour parameter.
A number between 0 to 23
This is the Day parameter.
A number between 1 to 31
This is the Month parameter.
A number between 1 to 12
Or the month name abbreviation in english (jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec)
This is the Day Of Week parameter.
A number between 1 to 7 with 1=monday, 2=tuesday, ..., 7=sunday
Or the day name abreviation in english (mon, tue, wed, thu, fri, sat, sun)
Table 8: Task Planner: Timer Interval syntax
Important: These 5 parameters are all required!
When used together, the dd and DDD parameters make an OR operation (every dd of the month or DDD).
In addition, there are some operators to specify multiple date/time.
Operator
*
,
-
/
Description
The * (asterisk) operator specifies all possible values for a field from Table 8.
For example, an * in the hh time field would be equivalent to 'every hour'.
The , (comma) operator specifies a list of values, for example: "1,3,4,7,8" (space inside the list must not be used)
The - (dash) operator specifies a range of values, for example: "1-6", which is equivalent to
"1,2,3,4,5,6".
The / (slash) operator (called "step"), which can be used to skip a given number of values.
For example, "*/3" in the hour time field is equivalent to "0,3,6,9,12,15,18,21".
Table 9: Task Planner: Timer Interval Operators
Examples:
Example
* * * * *
0 * * * *
0 0 * * *
*/15 * * * *
15 7 1 1 *
15 8 * * 1
0 8-18 * * 1-5
0 6,7,8,17,18,19 * * *
* * 13 * fri
Meaning
will do an action every minutes.
will do an action every hour.
will do an action on every day at midnight (00:00).
will do an action every 15 minutes.
will do an action at 7:15, the first of january. Equal to ’15 7 1 jan *’ will do an action at 8:15, each monday. Equal to ’15 8 * * mon’ will do an action at every hour between 8:00 and 18:00 on every working day (monday to friday) will do an action at 6, 7, 8, 17, 18 and 19 o’clock on every day.
will do an action at every minutes on each friday OR the 13th of the month (and not only on the friday 13th).
Table 10: Task Planner: Timer examples
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 20
General Reference Guide
3.3.1.5.2
Edit Action page
When you clicked on the Edit Button , you open the Action page.
eWON Configuration
Figure 15: Task Planner: Action page
This page is the same configuration page as for TagAlarm.
See "Tag "Alarm Action" edit window" on page 87 to find all parameters explanations.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 21
General Reference Guide eWON Configuration
3.3.2
Net services setup
Regarding its Internet connectivity features, the eWON has basically two modes of operation:
• A server mode (Web server and FTP server)
• A client mode (Email client, FTP client and NTP client)
In the server mode, the eWON is waiting for a client to connect with its Web browser or with its FTP client.
In the client mode, the eWON needs to connect to a server. For this connection, you should at least know the IP address of the server and the
Port number for the required service. Sometimes a username and a password are also required.
Note: Except in some special cases, the Port number is usually the default value proposed by the eWON. This setup section is used to define the eWON’s CLIENT MODE configuration.
3.3.2.1
Virtual Com Port Setup (VCOM)
3.3.2.1.1
Introduction
VCOM (or more precisely « Virtual COM port ») is a technology that consists in using the eWON’s serial port as if it was a standard COM port of a PC running Windows.
Actually, a software is installed on the PC; this software is a kind of driver that simulates additional COM ports on your PC. The PC is communicating with the eWON and the eWON serial port outputs all data transferred through the PC virtual serial port. The PC virtual port receives all data received by the eWON’s serial port.
PC with Virtual COM driver linked to eWON eWON VCom serial port linked to serial device
Figure 16: Virtual COM Port link used to read data on serial devices through eWON
The eWON supports two kinds of VCOM mode and an additional mode which is not exactly classified as a VCOM mode although it has the same purpose.
3.3.2.1.2
RAW TCP
The first mode is called RAW TCP. This is a basic mode thanks to which the PC opens a TCP/IP socket to the eWON on a predefined port. This socket is used to exchange data from and towards the eWON’s serial port.
The Serial port configuration (baud rate, parity, etc.) must be defined in the eWON’s configuration. The serial port signals (RTS, DTR, etc.) are not exchanged between the PC and the eWON.
This mode can also be used to create simple TCP/IP applications that need to communicate through the eWON’s serial port, as the only requirement is to open a TCP/IP socket on the eWON.
3.3.2.1.3
TELNET RFC2217
This is a more complex communication protocol between the PC and the eWON. In addition to the RAW mode this mode allows to control remotely the eWON’s serial port. Every configuration change that is made to the PC virtual COM port is automatically applied to eWON serial port. For example if you open a HyperTerminal on the PC’s virtual serial port and you change the serial port’s baud rate, the eWON’s serial port baud rate will change accordingly.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 22
General Reference Guide eWON Configuration
Another feature of the TELNET RFC2217 mode is its ability to change the modem line status. This means that the RTS/CTS, DTR, DCD (etc.) levels of the eWON’s physical port are reflected to the PC virtual port and vice-versa.
This protocol is called TELNET RFC 2217 because it has been standardized and described in an RFC specification. It means that any client supporting the RFC2217 protocol can use the eWON as a virtual port server.
3.3.2.1.4
MODBUS/TCP MODBUS/RTU Gateway
Although it is possible to use this technology to transfer almost any type of data through the virtual serial port, some protocols require special handling for efficient operation. ModbusRTU is one of these protocols and VCOM technology does not apply well to that protocol. For Modbus
RTU communication it is recommended to use the MbsTcpCOM software and use the eWON as a ModbusTCP to ModbusRTU gateway.
3.3.2.2
PC Virtual COM Port driver
There are different options for creating virtual serial ports on the PC side.
3.3.2.2.1
eVCOM software
This software provided by eWON s.a. is used to create multiple virtual COM port on the PC.
This software is downloadable for free from http://support.ewon.biz
.
More eVCOM information on the eVCOM-Getting Started document.
3.3.2.2.2
Other software
Tactical Software provides Serial-IP, http://www.tactical-sw.com
This software is not for free. It can be purchased directly from the Tactical software website.
An 30 days-evaluation version is available for download from this site.
The software supports both RAW TCP and Telnet RFC 2217 modes and works on all Windows version from Windows 95 to Windows XP.
The software can create up to 256 virtual serial ports that communicate with multiple eWONs.
3.3.2.3
eWON VCOM Configuration
3.3.2.3.1
Introduction
All serial ports can be used for VCOM.
Depending on the eWON type, you have 1, 2 or 4 serial ports.
The COM1 is always the serial port 1 of the eWON.
The COM2 is always the MODEM port (even if there is no modem present on your eWON, the COM2 exists but is useless).
The COM3, if present, is linked to the serial port 2 (SER2), the full RS-232 port on eWON4002.
The COM4, if present, is linked to the serial port 3 (SER3).
As COM2 is the modem, it should only be used for debug purposes because when the port is used by VCOM it is not available to PPP or SMS communication.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 23
General Reference Guide eWON Configuration
3.3.2.3.2
Web configuration
You get access to the COM1 (or COM2) VIRTUAL PORT CONFIGURATION page by following this path from the Main Menu navigation bar:
Configuration/System Setup/General/Net services/Virtual Com :
Figure 17: eWON Virtual COM port configuration page
You may first choose the COM port you want to configure in the COM Port: scrolling menu. You can then define the following parameters:
Control
Port Type
TCP Port
Poll Signal Interval
Debug
Always accept new clients
Inactivity Timeout
Line parameters
HW Mode
Description
Choose the port type between RawTCp, Telnet RFC2217 or Disabled.
The PC will have to connect to that TCP/IP port to communicate through the eWON serial port.
REM: if multiple VCOM are defined on the same eWON, they must all use a different TCP/IP port.
This parameter is only used in TELNET RFC2217 mode. In that mode the eWON will scan the modem port for changes in modem line input levels (CTS, DSR, DCD, RING) thus this parameters defines the scan rate. The default value of 100msec should be fast enough for most applications.
Activate the recording of debug info for VCOM. When activated, this function slows down the overall perfomance of the eWON.
All debug info will be accessible in the Diagnostic->Real Time Log menu.
When a PC is connected to the eWON, then a socket is opened by the PC to the eWON. If for example the PC suddenly switches off, the eWON will not know that the socket should be closed, and when the PC will try to connect again, the eWON will refuse the connection. This option is provided in order to avoid that situation; when checked, the eWON will always be ready for a new connection, and the new connection will replace the previous connection. This means also that if one PC is connected to the VCOM port, and that another PC tries to connect with this option checked, the new PC connection will be accepted and the existing PC connection will be closed.
There is another way to avoid that an unused but opened socket prevents access to the eWON (if the previous option has NOT BEEN checked). If you set this option with a value different of 0, then the eWON will close its VCOM socket if there is no communication for a given amount of time. If serial communication is supposed to occur all the time this option can be useful, but if silence in communication is expected, then this option will obviously not apply.
Except for HW Mode, which is an "hardware parameter" (only configurable in the eWON), these parameters are only used when the port is configured in RAW TCP mode, because in TELNET RFC2217 mode the PC virtual port will usually change them. In any case, this will define the initial or default values.
Hardware Mode represents the hardware behavior of the serial link. Available values are :
• HalfDuplex
• FullDuplex with HardWare handshaking (default)
• FullDuplex with NO handshaking
REM: This mode cannot be controlled remotely by RFC 2217
Table 11: eWON virtual COM port configuration controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 24
General Reference Guide
When using modem port for VCOM, the following must be considered:
• Modem serial port is normally owned by PPP:
• If an SMS transfer is in progress and a VCOM client tries to connect, the VCOM connection will fail.
• If a VCOM client is connected, and an SMS must be sent, the SMS sending will fail.
• When an SMS transfer or a VCOM connection ends, the PPP is again the owner of the modem serial port.
eWON Configuration
3.3.2.4
SMTP (mails) setup
Figure 18: eWON setup SMTP page
Control
SMTP server address
SMTP Server port
Email "From" User name
User name
Password
Description
The IP address of the SMTP server which the Email notification will be sent to. Put SMTP server IP address. If
located inside an Intranet, providing the IMC (Internet Mail Connector) ad-in is installed on the Exchange Server, and this service is configured to accept incoming mails sent by the eWON.
Usually the value is 25. In case of doubt, contact your Internet provider or your Network Administrator to check it.
The name of the eWON Email account. For instance: [email protected]. Will appear in the FROM field of the message sent.
SMTP AUTHENTICATION: insert here the user name. (leave empty if no authentication is required)
SMTP AUTHENTICATION: enter here the password. (leave empty if no authentication is required)
Table 12: eWON SMTP controls
.
After having encoded your parameters, go to the bottom of the page to
3.3.2.5
NTP (time) setup
RG-001-1-EN rev. 2.1
Figure 19: eWON NTP setup page
eWON® - 14/01/2014 - ©eWON sa Page 25
General Reference Guide eWON Configuration
Control
Enable NTP clock update
NTP server address
NTP Server Port
GMT Offset
Update Time Interval
Description
To update the eWON date & time the eWON is able to make a connection automatically on a NTP (Network
Time Protocol) timeserver. If you want to use that functionality, check the box and fill the next edit boxes in.
The IP address of the NTP (Network Time Server Protocol) server. You can easily find a list of NTP servers by using any Web search engine. If you only know the name of the NTP server (like canon.inria.fr) see the chapter
"Finding the IP address of a given host" on page 231.
Note: eWON does not consider the DST data (Daylight Saving Time).
Usually 123. In case of doubt, contact your Internet provider or your Network Administrator to check it.
Enter here the offset in hours between your local time zone and the GMT time zone. This information is required for correct automatic time update.
Interval in minutes for automatic connection to the NTP Server. Default is 1440= 1 day.
Table 13: eWON NTP controls
After having encoded your parameters, go to the bottom of the page to .
3.3.2.6
FTP setup
Figure 20: eWON FTP setup page
Control
FTP server address
FTP server port
User name
Password
Use Passive Mode
Description
The name of the FTP server where the Put FTP command will be issued (from alarm action or Script direct
PUTFTP command). Enter FTP server IP address. If you only know the name of the FTP server (like
domain.com) see the chapter "Finding the IP address of a given host" on page 231.
Usually the value is 21. In case of doubt, contact your Internet provider or your Network Administrator to check it.
The FTP client user name defined on the FTP server.
The password for the given FTP client.
When checked, all FTP transactions are performed in passive mode.
Table 14: eWON FTP setup controls
After having encoded your parameters, go to the bottom of the page to .
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 26
3.3.2.7
SNMP Setup
General Reference Guide eWON Configuration
Figure 21: eWON SNMP setup main menu page
3.3.2.7.1
Communities
The communities are defined here. These are acting like a "login-password" feature. Please refer to the SNMP standard for detailed explanations.
Up to five different communities can be set up in the eWON. Each community has different read and write attributes. In the eWON, each of them can be specified for read and/or write rights. The standard public community is defined as read-only.
3.3.2.7.2
Hosts
The hosts that can access the communities and/or receive the generated SNMP traps have to be specified. If the checkbox Accept SNMP from
any host is selected, any IP address will be granted to browse the SNMP tree of the eWON.
The traps are always sent to know IP addresses defined in the following fields. Each host is determined by its IP address and by the community he is working on. For each host, the user can specify whether he can receive traps and/or browse the SNMP tree.
A MIB file describing the SNMP structure and OID of the eWON is available on our web site.
Traps can originate from three different events:
System traps
Basic scripting traps
Alarm event traps
At cold boot and at soft reboot, the eWON sends system traps with identification 0 and 3 respectively.
The sendtrap Basic function can send a trap at user request.
The eWON automatically sends a trap on alarm, containing alarm information.
Table 15: events that generate a SNMP trap
The parameters for Basic traps are as follows:
Param 0
Param 1
Text string [0...255]
Integer 32bits
Table 16: Basic SNMP traps parameters
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 27
General Reference Guide
The parameters for Alarm traps are as follows:
Param 0
Param 1
Param 2
Param 3
Param 4
Tag name
Alarm message
Value of the Tag in alarm
Alarm status
Alarm Type
Table 17: Alarm traps parameters
3.3.2.8
Data Management
eWON Configuration
(Text [0..63])
(Text [0..255])
(Integer 32bits)
(Integer)
(Integer)
Figure 22: Data Management config page
eWON can upload automatically historical data to the eSyncDMserver.
The upload can occur:
• on a defined interval
• on a complex schedule
• on alarm
• on a trigger from the Basic program
Control eWON Data Management ID
Password
Server URL
Upload interval
Advanced data transfert schedule
Selected Group(s)
Upload on alarm
Description
eWON Identifier specified on the eSyncDM server (mandatory)
Password to access the eWON account on the server (may be empty)
Address and port of the eSyncDM. Could be an IP address or an URL
If port is omitted, 80 will be used.
ex: 10.0.120.251 or data.myserver.com:8080
The interval in minutes between each upload of data
Set to 0 if you want to use the "Advanced data transfert schedule" or upload upon alarm
Schedule the upload the same way as "Task Planner" see "Task Planner" on page 16 to complete syntax description ex: 0 */6 * * * will upload every 6 hours (at 0, 6, 12 and 18 o’clock)
Data management sends only tags belonging to group. Select which group(s) you want to upload.
When selected, the upload will be triggered also when one of the tags of the selected groups rises an alarm.
Table 18: Data Management parameters
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 28
General Reference Guide eWON Configuration
3.3.3
Diagnosis
3.3.3.1
Overview
This part of eWON configuration allows you to fine-tune the way you monitor the eWON, concerning the events, that gives the user the ability to diagnose quickly and efficiently any trouble that could happen.
The second choice in the Diagnostic menu is PPP Dump, which allows you to log the history of any PPP communication to and from eWON.
Since Firmware 5.4s4, a Debug page allows the activation of debug information for Serial Ports or ADSL.
3.3.3.2
Events logging
Event logging Configuration gives you the ability to define the reporting level you want to get a diagnostic from most important part from eWON's features.
The three different reporting levels that can be defined are:
Trace
Warning
Error
The events with level "Trace", "Warning" and "Error" will be logged
The events with level "Warning" and "Error" will be logged
Only the critical events will be logged
Table 19: reporting levels - explanations
Warning: If for example you define the "Error" reporting level for "IP communication", then you won't be able to retrieve the reporting information concerning the "Warning" and "Trace" levels in the events log file. This means that you have to know exactly what are the eWON features you want to keep an eye about potential issues or not.
Figure 23: Event logging configuration page
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 29
General Reference Guide eWON Configuration
Control
Initialisation
Configuration
IO Server
Modem Communication
IP Communication
Serial Communication
Kernel
Web Interface
Security
Other Applications
Description
Allows you to define the level of monitoring about the events concerning the eWON boot.
Allows you to define the level of monitoring about the events concerning the eWON configuration.
Allows you to define the level of monitoring about the events concerning the IO Servers that eWON manages.
Allows you to define the level of monitoring about the events concerning the eWON's modem communications (incoming and outgoing).
Allows you to define the level of monitoring about the events concerning the eWON's IP communications.
Allows you to define the level of monitoring about the events concerning the eWON's serial communications.
Allows you to define the level of monitoring about the events concerning the eWON's kernel.
Allows you to define the level of monitoring about the events concerning the eWON's Web
Interface.
Allows you to define the level of monitoring about the events concerning the eWON's security
Allows you to define the level of monitoring about the events concerning the eWON's features that are distinct from all the one that are listed above in this table.
Table 20: events logging configuration controls
3.3.3.3
PPP Dump
WARNING: depending on the eWON's version (c.f. Table 198 on page 209)
WARNING: this configuration is volatile, which means that the dump.ppp file will be cleared each time that the eWON is rebooted.
The dump.ppp file containing the logged data can be used in the following ways:
• it can be sent as an attachment to an e-mail or by using the $dtPP Export Block Descriptor
• it can be found in the eWON FTP root and then downloaded locally or on another FTP folder
• it can be opened and analyzed by using EtherReal, which is a tool used to analyze TCP frames ( http://www.ethereal.com/ )
3.3.3.3.1
PPP Dump Configuration
Figure 24: PPP Dump configuration page
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 30
General Reference Guide eWON Configuration
Control
Log Incoming call
Log Outgoing call
Log Size (bytes)
Append to log
Log following connections clear log now
Description
Logs communications when the eWON is acting as a PPP server
Logs communication when the eWON is acting as PPP Client (connects to a server)
Number of bytes allocated for logging PPP communications.
When the log is full, logging stops (this does not prevent communication from continuing)
Maximum log size is 1MByte (Log Size between 50000 and 100000 are sufficient for debug purpose)
Prior to append to log, you must clear log manually using the Clear Log button in the PPP Dump configuration page
The eWON will log only the N next connections, the number of connections will be decreased each time a new connection is logged. When the last connection has been logged, then the counter will be set to -1
(to prevent further connections to be logged).
When the value of this counter is 0, then all connections are logged.
You can manually set the counter to -1, in order to suspend connection logging, but if you want to release the log buffer, then you should disable the Log Incoming call and the Log Outgoing call options.
In case you want to log multiple connections, you can choose to Append data to the log or not.
Clicking on this button will clear the PPP dump log.
Table 21: PPP dump configuration controls
3.3.3.4
Debug
Control
Debug COM (1..4)
Debug ADSL
Error Debug
Figure 25: Debug configuration page
Description
Set the debug mode of the Serial COM ports (1 to 4 depending of the eWON type).
Choose between following mode:
• No debug:
• HEX on RX/TX:
no debug information logged (default)
Log hexadecimal data received and transmitted
• HEX and ASCII on RX/TX:
Log hexadecimal and ASCII data received and transmitted
• HEX and ASCII (no timeout): Log hexadecimal and ASCII data received and transmitted, without timeout information (clearer log)
Only available on eWON2104 or eWON4104.
Log ADSL trace in the ADSL log page (See "ADSL Log" on page 191)
Append hex location data to logged events
Table 22: Debug configuration controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 31
General Reference Guide
3.3.4
COM Setup section
Warning: depending on eWON's version (c.f. Table 198 on page 209)
eWON Configuration
The second link of the System setup is the communication setup. All Ethernet, modem and PPP TCP/IP connectivity parameters are defined here.
The tree menu is divided into 4 sub-menus, which classifies the COM setup into functional systems: Interfaces,
Network connections, Networking Config and Manage Config.
Once totally expanded, the tree menu looks like the one shown on the right.
• Important: This COM configuration is not saved in the eWON flash file system, it means that formatting the eWON will not erase this configuration. This allows formatting the eWON remotely and ensuring that communication is still possible after formatting. Nevertheless, the Default Config menu allows the user to return to default well known communication values.
3.3.4.1
Interfaces setup
The Interfaces menu groups the hardware configuration of the means of communications.
These interfaces are:
• the Modem (optional)
• the Ethernet-1-LAN (always present)
• the Ethernet-2-WAN (only on eWONx005 & eWONx005CD)
• the ADSL (only on eWONx104)
Therefore, eWON will show you only the interfaces available on your device.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 32
General Reference Guide eWON Configuration
3.3.4.1.1
Modem setup page
Warning: depending on the eWON's version (c.f. Table 198 on page 209)
3.3.4.1.1.1
Modem configuration (PSTN modem)
This tab contains the Modem setup of the eWON and stands in a distinct page from Dialup Setup since version 4. Its appearance differs depending on the type of modem that the eWON embeds; if a PSTN modem, then the modem settings page will only contain the Modem Init
String field (see figure below):
Figure 26: Modem settings for eWON with PSTN modem
Control
Modem Detected
Modem Init String (Basic Part)
Description
Textual description of the eWON internal modem detected, if available.
The text that is displayed is always "Internal", followed by the modem type or speed
(i.e. "Internal 56K" in the screenshot above).
This string is used to configure and to initialize the modem.
Any change in this string could prevent communications to succeed, for that reason only qualified users should modify this string.
It can be useful to modify this string i.e. if you install eWON in a country where the telephone network is different than in your country
Clearing this string will result to applying a well known default initialization string (after you have validated your choice by clicking on the Update button.
Table 23: eWON PSTN modem settings controls
3.3.4.1.1.2
Modem configuration (GSM/GPRS modem)
If eWON embeds a GSM/GPRS modems, then the modem page will have a very different look:
RG-001-1-EN rev. 2.1
Figure 27: Modem settings for eWON with GSM/GPRS modem
eWON® - 14/01/2014 - ©eWON sa Page 33
General Reference Guide eWON Configuration
Control
Modem Detected
Signal Level
Network
Operator
Modem Init String (Basic Part)
Operator selection
Wireless Network
Display Level on led
GSM PIN Code
(reboot required)
Description
Modem Status
Textual description of the eWON internal modem detected, if available.
The text that displays is always "Internal", followed by the modem type or speed (i.e. "Internal
MUTLIBAND GSM" in the screenshot above).
Indicates you the current signal level for your GSM/GPRS communication.
This signal range must be between 20 and 31 (signal levels lower than 18 could work, but the communications could be slower or even interrupted).
Check your local environment and your antenna isolation/power if you get a 0 or a 99.
This field indicates if you are able to connect to the GSM/GPRS network. You should read "Home
network" or "Roaming" in order to communicate safely.
Displays the currently selected GSM operator used.
Modem Config
This string is used to configure and to initialise the modem.
Any change in this string could prevent communications to succeed, only qualified users should modify it.
Clearing this string will result to applying a well known default initialisation string (after you have validated your choice by clicking on the Update Modem Settings button).
Combo box to choose (force) a GSM operator. The combo will show all the available GSM operator and an "Automatic" settings. Default setting is Automatic.
Combo box to choose (force) the GSM network type. This is useful if the user want to force the modem in a specific mode, either for contract reason of for reception level improvement (sometimes the modem will lock on the 3G network with a poor reception while the GSM reception would be excellent – with a slow connection though). Possible selections are:
• WCDMA/GSM preferred
• WCDMA only
• GSM only
For 3G modems (UMTS and HSUPA) the default setting is "WCDMA/GSM prefered".
For 2G modems, the menu is present but there is only 1 option: “GSM only”
The modem led default behavior is to go solid green when a PPP is established and off otherwise.
Enter here the currently valid PIN code of the SIM card that you have inserted in eWON.
PIN code of any size are valide since Firmware 6.2.
Let empty if your SIM card doesn’t require a PIN code.
This PIN code will be taken in account only after you have power OFF/power ON eWON.
Table 24: GSM Modem configuration controls
note: Unused parameters are hidden. You must check the Enabled checkbox to expand the parameters
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 34
General Reference Guide eWON Configuration
Figure 28: Modem settings for eWON with GSM/GPRS modem (all parameters)
GPRS Settings
In order to generate a GPRS outgoing communication, the user must choose "GPRS" in the Connection type field from the Server1(or 2)
Notes:
• Each part of the GPRS configuration can be enabled or not.
• If your GPRS provider requires authentication when login in the GPRS network, the login and password must be entered in the
Server1 configuration page, see chapter "Primary & secondary servers" on page 46.
• Some network operators use authentication to identify the mobile phone connecting to their GPRS network.
PDP context definition
Access Point Name (APN)
Packet Data Protocol Context
Must be enabled in order to use GPRS connection.
Enter the Internet address of your access point.
Contact your GSM service provider to know your APN.
Table 25: eWON GPRS main settings controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 35
General Reference Guide eWON Configuration
Quality Of Service Profile (Requested)
Check with your network operator before changing any of the QoS (Quality of Service) settings.
The settings Precedence, Delay, Peak rate, Reliability and Mean Rate are all set by default to "Subscribed", which means that your operators default QoS (Quality of Service) values will be applied.
precedence delay reliability peak mean
a numeric parameter which specifies the precedence class a numeric parameter which specifies the delay class a numeric parameter which specifies the reliability class. a numeric parameter which specifies the peak throughput class
precedence delay reliability peak mean
a numeric parameter which specifies the mean throughput class
Quality Of Service Profile (Minimum Acceptable)
a numeric parameter which specifies the precedence class a numeric parameter which specifies the delay class a numeric parameter which specifies the reliability class. a numeric parameter which specifies the peak throughput class a numeric parameter which specifies the mean throughput class
Table 26: eWON GPRS quality of services (QOS) settings controls
3.3.4.1.1.3
Modem configuration (ISDN)
Control
Modem Detected
Figure 29: Modem settings for eWON with ISDN modem
Modem Init String (Basic Part)
Multiple Subscriber Number (MSN)
Description
Textual description of the eWON internal modem detected, if available.
The displayed text is always "Internal ISDN".
This string is used to configure and to initialize the modem.
Any change in this string could prevent communications to succeed, for that reason only qualified users should modify this string.
Clearing this string will result to applying a well known default initialization string (after you have validated your choice by clicking on the Update button.
Use this field to encode the phone number which you want the eWON answer.
Leave the field empty (default) to answer all the phone numbers of this ISDN line.
Table 27: eWON ISDN settings controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 36
General Reference Guide eWON Configuration
3.3.4.1.1.4
PSTN: Leased line configuration
PSTN modem types MT5634SMI-xx have the ability to work in Leased Line mode.
In this mode, you are able to connect by phone two eWONs with simple wires.
The two eWONs must have a MT5634SMI-xx modem.
One side acts as the client and you must insert the LLCLT command in the init string.
The other side acts as the server and you must enter the LLSRV command in the init string.
The init string MUST start by LLCLT or LLSRV for LeasedLine mode operation but the init string can continue with other parameters.
Example:
LLSRV;AT&FE1&Q5&K3&D2&C1
Or:
LLSRV or
LLCLT or
...
The link is established by the CLIENT. This eWON Client can be configured with following parameters:
Modem Init String
Call direction allowed
Primary Server ' Phone number
Primary Server ' User Name
Primary Server ' Password
LLCLT
Outgoing Only
0
adm
adm
Note: Username and password of an user on the eWON Server.
The eWON Server can be configured with following parameters:
Modem Init String
Call direction allowed
LLSRV
Incoming Only
• When the dial-out occurs, it takes up to 2 minutes to synchronize both eWONs.
• The Server modem leased line (LLSRV) cannot generate outgoing calls, or it would generate an error.
• The Client modem leased line (LLCLT) cannot receive incoming calls.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 37
General Reference Guide eWON Configuration
3.3.4.1.1.5
ADSL interface
The eWON ADSL modem supports the ADSL2+ standard.
The configuration is very simple and provides compatibility with PPPOE and PPPOA with VCMux and LLCMux implementations.
When the ADSL modem is connected, the eWON will have a WAN interface connected to the Internet, it will be able to act as a gateway on the
Internet and will be accessible from Internet on any port.
Control
Connection Type
User name
Password
PPP Mode
VPI
VCI
Figure 30: ADSL interface settings
Description
Always "PPPoE or PPPoA"
PPPoE: Point-to-Point Protocol over Ethernet
PPPoA: Point-to-Point Protocol over ATM
Provided by the operator with your ADSL account
Provided by the operator with your ADSL account
Provided by the operator with your ADSL account.
Choose between
• PPPoE LLC
• PPPoA VC-Mux
• PPPoA LLC
Virtual Path Identifier is provided by operator (default: 8)
Virtual Channel Identifier is provider by operator (default: 35)
Table 28: ADSL interface settings controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 38
General Reference Guide
3.3.4.1.2
Ethernet LAN & WAN
From the hardware point of view, there is nothing to configure on the Ethernet interfaces.
You find here the MAC address of the Ethernet Interface.
eWON Configuration
Figure 31: Ethernet Interface info page
3.3.4.2
Network connections
The "Network connections group" handle all the software parameters of yours connections.
You can configure here:
• IP parameters of your(s) Ethernet(s) connection(s)
• Incoming and Outgoing connections of your Modem
• ADSL global connection parameters
• Incoming and Outgoing VPN parameters
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 39
3.3.4.2.1
Ethernet LAN (& WAN)
3.3.4.2.1.1
General
This tab contains the Ethernet setup of the eWON.
General Reference Guide eWON Configuration
Figure 32: Network connections: Ethernet setup
An ethernet interface needs the following parameters:
Control
Ethernet IP address eWON Ethernet IP mask
Ethernet IP gateway
Primary DNS IP address
Secondary DNS IP address
Network Name
Description
Address Setup
IP address of the eWON on the LAN (or WAN) side. Use this IP address to connect to the eWON using a LAN (or WAN) connection. These are 4 numbers from 0 to 255 separated by dots.
eWON Ethernet subnet mask, used to determine the address range of the LAN (or WAN) connection (your network).
eWON Ethernet server gateway, which is the IP address used to forward information to other networks.
note: See also "Ethernet Gateway behavior" on page 57
DNS Setup
IP address of the primary Domain Name Server of your domain or ISP provider.
These are 4 numbers from 0 to 255 separated by dots,
IP address of the secondary Domain Name Server of your domain or ISP provider.
These are 4 numbers from 0 to 255 separated by dots
DHCP config
On the DHCP network, you can also access your device by name instead of IP address.
Thanks to the DNS Synchronisation (RFC 4702), this Network Name (also called Fully
Qualified Domain Name, or FQDN) is sent to the DHCP server during DCHP request negociation and will trigger an update of the DNS server.
Network Name can only contains characters a-z,-,0-9
Table 29: Ethernet setup configuration page
The Ethernet LAN and WAN interfaces can receive their IP address configuration from various mechanisms:
• Static: the user enters all parameters
• BootP: a BootP server provides some parameters
• DHCP: a DHCP server provides all parameters
You select the IP address configuration mechanism with the combo box
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 40
General Reference Guide eWON Configuration
Each mechanisms provides you all or some of the IP parameters.
IP parameters
IP Address
IP Mask
Default Gateway
DNS
(primary and secondary)
Network Name
Static
X
X
X
X not applicable
BootP
X
X
(*)
(*) not applicable
DHCP
X
X
X
X (optional)
Table 30: IP parameters provided by IP configuration mechanisms
X
(*) this parameter must be configured statically.
(optional) this parameter can be configured by the Server or statically
On the eWON the Default Gateway and DNS belong to one interface only:
- the LAN for eWON with one ethernet interface
- the WAN for eWON with two ethernet interfaces
Depending on the eWON type, the LAN and WAN interfaces will show you the parameters that you are allowed to set manually.
The other parameters are greyed.
On eWONs with one ethernet interface (other than 2005 or 4005), the LAN configuration page will be one of the following:
Static BootP DHCP
Table 31: One ethernet : LAN configuration pages
On eWON with two ethernet interface (eWON2005 or 4005), the LAN configuration page will be one of the followings:
Static BootP DHCP
RG-001-1-EN rev. 2.1
Table 32: Two ethernets : LAN configuration pages
eWON® - 14/01/2014 - ©eWON sa Page 41
General Reference Guide eWON Configuration
On eWONs with two ethernet interfaces (eWON2005 or 4005), the WAN configuration page will be one of the followings:
Static BootP DHCP
Table 33: Two ethernets : WAN configuration pages
IMPORTANT: Since firmware 5.4, on eWON with 2 ethernet interfaces, the WAN ethernet interface is disconnected by default, but since firmware 6.2, the "Maintain connection" is enabled by default, thus the WAN ethernet interface is active by default.
See "WAN/LAN/PPP interface management" on page 55
3.3.4.2.1.2
BootP : TCP/IP Bootstrap Protocol
You can force eWON to ask its IP address to a BootP Server.
Only the IP address and network mask are given by the BootP server.
To correctly set the IP address and mask, your BootP server must comply with the RFC-1048.
At each startup, the eWON will receive its IP address from the BootP Server.
The eWON will wait for the server unless it is already present.
The eWON will perform a new attempt at increasing interval (1 minute interval max.) endlessly.
While waiting for its IP address, the eWON is in startup phase and thus it is not functioning! During this time, the USER LED will blink continuously with the following pattern: short red light + pause + long green light + pause
Resolution:
1) Pushing on the Reset button (on the front side of the eWON) will skip the BootP request, then eWON will use the IP address which is configured in the Ethernet configuration page
The Duplicate IP test is skipped too!
the BootP mechanism eWON is now accessible.
3.3.4.2.1.3
DHCP : Dynamic Host Configuration Protocol
Configured on DHCP, the eWON gets all the IP parameters from the DHCP server.
These parameters are: the IP address, network mask, default gateway and the 2 DNS servers. The DNS servers can optionally be defined statically.
At the end of the DHCP request, the User Led will blink with the following pattern during 2 seconds:
short green light + short pause
Note: If the eWON doesn’t find any DHCP server, after 45 seconds, it will set:
On WAN interface, the IP 169.254.0.53 with mask 255.255.0.0
On LAN interface, the IP 169.254.1.53 with mask 255.255.0.0
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 42
General Reference Guide eWON Configuration
3.3.4.2.2
Modem Incoming & Outgoing
Warning: Depending on the eWON's version (c.f. Table 198 on page 209)
This group contains the PPP(Point to Point) setup of the eWON that sets up the PPP settings for the server and client functions of the eWON engine.
3.3.4.2.2.1
Incoming
Figure 33: Modem Incoming setup page
Control eWON PPP server IP address
PPP client IP address
Enable protocol compression
Use incoming for outgoing
Idle time before hanging up
Reset eWON if no incoming connection after ...
Description
PPP server Internet protocol (IP) address of the eWON. Use this IP address to connect to the eWON using a RAS connection. These are 4 numbers from 0 to 255 separated by a dot.
Type the IP address that the eWON will allocate to the RAS client to establish the communication.
Enables the compression negotiation request when an incoming call occurs. This includes all the compression modes known by the eWON PPP engine (Van Jacobson, header compression,…).
When checked, this ensures that when an incoming call is undergoing, no external event, such as alarm Email, will drop the line in order to initiate a new connection. If an alarm has to be sent through the PPP connection (FTP, Email, …), the current PPP link will be used. Be aware that SMS alarms will always drop the line, whatever the value of this checkbox. On the other hand, if this box is unchecked and an Email has to be sent while the connection has been established by a user to browse the eWON, if the Email can be sent through the Ethernet link, the PPP link will NOT be dropped.
note: See also "Ethernet Gateway behavior" on page 57
Number of rings before modem answers
You can fix the number of rings before the eWON answers. Default value is 0.
After this amount of time without data transfer on the PPP link between the eWON (any type of PPP packet) and a remote host (Computer).
Select between Check incoming or Check outgoing to select the monitored traffic.
Note: this is the same parameter as for outgoing connection.
Consider this parameter like a Watchdog parameter. To avoid eWON to stay stucked due to any modem reason or other, you can use this parameter to force an eWON to reboot if no incoming connection was performed after xxx Hours since the last connection.
Table 34: Modem Incoming controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 43
3.3.4.2.2.2
Outgoing
Global parameters
General Reference Guide eWON Configuration
Figure 34: Modem Outgoing Global setup page
Control
Dial and connection timeout
Enable compression
Delay between dialout retries
Idle time before hanging up
Description
Time allowed for the whole establishment of the PPP link to be up. This means modem call, modem negotiation, PPP negotiation and logon. This time includes all trials on each server.
This is thus a global time.
Enable the compression negotiation request when an outgoing call occurs. This includes all compression modes known by the eWON PPP engine (Van Jacobson, header compression,…).
In case of an unsuccessful attempt to establish the outgoing communication, then eWON will retry to establish it again. This parameter will allow you to define the amount of time the eWON will wait to try and establish again the outgoing action.
eWON will hang up after this amount of time if no data transfer occurs on the PPP link between the eWON (any type of PPP packet) and a remote host (Computer).
Select between Check incoming or Check outgoing to select the monitored traffic.
Note: this is the same parameter as for incoming connection.
Max outgoing call duration
Hang up if no outgoing action after
The maximum amount of time of the outgoing call. When this amount of time is reached, then the eWON stops the PPP communication.
When a PPP link is triggered by an outgoing action (not by DialOnDemand), you can force the interruption of the line immediately after the actions (set 0) or let the PPP active for an amount of time (set >0). The PPP link will be shut down after the x minutes even if transfers are in progress.
The Idle time before hanging up is always active.
Table 35: outgoing calls configuration controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 44
General Reference Guide eWON Configuration
Select next server in case of error
Reset modem after
Minimum GPRS connection duration
Reset GPRS modem after
Allocated Budget
Reset budget period
Current period budget
Current VOL IN/OUT info
Reset
When the call to a server failed, you can choose the behavior of the next call.
eWON will be configured to:
• Use last valid server
• Always return to server 1
• Use only server 1
• Use only server 2
Consider this parameter like a Watchdog parameter. To avoid eWON to stay stucked due to any modem reason, you can use this parameter to force a reset of the modem after xxx outgoing calls failure.
Only available on eWON with GPRS modem.
Time in seconds: if the GPRS dial-out connection is shorter than this time, the connection is considered as ERROR.
If set to "-1", this time is not tested (default value = 4).
See "Note: GPRS modem connection error management" on page 45.
Only available on eWON with GPRS modem.
Maximum number of GPRS connection ERROR accepted before the modem is reset
(default value = 5).
See "Note: GPRS modem connection error management" on page 45.
This is the allocated time budget for outgoing calls. When a communication initiated by the eWON is in progress, the current period budget (remaining time) is reduced.
When all the time budget is used, the eWON cannot make outgoing call.
This is the time allowed in order to use the budget. After the call period is over, a new period is started and the new period timer is reset to this value. In the above example, this means that the current budget period is reset to 24 hours each 168 hours. The reset period is restored to its value each time one of the three configuration fields is modified.
This is the remaining call budget for the current period, expressed in hours:min:sec. A new budget can be provided; this restarts a new reset period. For example, in the above example
24 hours are remaining, if we force 100 hours as call budget, the reset period is reset. This means that for the newly started period, 100 hours are allocated. A new period will start again in a delay of 168 hours.
Information: counters of volume transmitted (IN and OUT)
You can reset it by checking the ’Reset’ box.
Table 35: outgoing calls configuration controls
Click on the Update button when you have filled this part of the eWON configuration.
Note: GPRS modem connection error management
The "Minimum GPRS connection duration" and the "Reset GPRS modem after" parameters have been added to monitor problems with GSM-
GPRS connection.
In case these problems occur, the result can be a short or unsuccessful PPP connection. In that case the Dialout Out to server works (CONNECT message received from the modem), then the PPP negociation starts and then:
1. either the PPP connection starts
2. or the LCP negociation fails but in any case the connection is short (less than 2 to 4 seconds).
In the first case above, a message is logged in the events.txt file saying:
eppp-Open client connection eppp-Close client connection (Cnxtime: 0 S. [2])
In the second case, the PPP connection does not start, but a message is logged in the events.txt file saying
eppp-PPP negociation failed. (user/password/pap-chap)
The problem may be due to a bad configuration of APN,user,password, authentication mode (CHAP, PAP), but it can also be due to a GSM problem for doing an "Attach" to the GPRS.
In that case, it may be required to reset the modem to help it recover.
REM1: these test only apply to GPRS connection, if username or password is invalid for another type of dial-out, the modem will not be reset.
REM2:
eppp-PPP negociation failed. (user/password/pap-chap)
The above message is generated for any type of dial-out that50 fails before PPP connection goes online.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 45
General Reference Guide eWON Configuration
Primary & secondary servers
The following parameters are the same for both servers. Two different servers can be set up. This ensures that the eWON can find a way out for
PPP link if a server is down. At the startup of a connection, the primary server is always dialed first. If the connection cannot be established, the eWON tries the second server. If it fails, then it toggles back to the primary server. This is done until the dial-out timeout is reached.
Figure 35: Modem Outgoing Server setup page
Control
Connection type
Server phone number
User Name
Password
Require secure authentication
(CHAP)
Description only present in GSM/GPRS modems.
Select the dialUp type: Remote acces connection or GPRS.
With GPRS, the Server phone number will be hidden (unused).
The complete phone number of the server. A coma (,) can be used to insert a pause (can be useful i.e. if you have to go through a pabx).
The User name of your ISP login for PPP link establishment.
The Password linked to the above login for PPP link establishment.
If this box is checked, then the eWON explicitly requests CHAP authentication for the PPP link. If the other side cannot do CHAP, no connection will be made. If this box is left unchecked, then PAP (clear text password) is used.
Table 36: Modem Outgoing Server configuration controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 46
General Reference Guide eWON Configuration
3.3.4.2.3
ADSL
Control
Connection timeout
Figure 36: ADSL global connection parameters
Description
The maximum time the eWON will wait for the ADSL WAN to be established.
After this time, the connection will fail. If Maintain Connecion is selected, then the eWON will retry continuously.
Table 37: ADSL global connection configuration control
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 47
3.3.4.2.4
VPN
General Reference Guide eWON Configuration
Figure 37: VPN Global setup page (without Internet connection Proxy)
Figure 38: VPN Global setup page (with Internet connection Proxy)
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 48
General Reference Guide eWON Configuration
Control
Diagnosis level
Port In
Port Out
’Keep alive’ interval
Internet connection Proxy
Proxy address
Proxy port
Proxy authentication
VPN Driver Mode
VPN Protocol
Talk2M PRO Account name
Talk2M Access Server
Address
Description
Choose the level of diagnosis reported in the "Real Time Log" on page 187.
Level could: None, Low, Medium or High
The TCP Port number where eWON will listen all incoming VPN traffic.
port <> 0
Only this port could be use for incoming VPN traffic.
0 = default behavior
• If VPN is initiated by the eWON (contacting eSync), the incoming port will be set dynamically
• If VPN is initiated by an external source (eCatcher), the eWON listens on the port 1194
(hardcoded)
The TCP Port number where eWON will send all outgoing VPN traffic (default 1194)
Set at which interval (in second) the eWON send a short packet to maintain the connection opened.
If the Internet access requires a proxy connection, the VPN (and only VPN) is able to use it.
Before Firmware 6.1, only the Wizard was able to edit these Proxy settings.
This Proxy could be of 3 types:
• Proxy with basic authentication
• Proxy with NTLM authentication
• Proxy without authentication
Enter the address of the Proxy server (not the name)
Enter the port of the Proxy server
Enter the User name and password required to access the Proxy server
Select the VPN driver mode you need. Available mode are:
• TAP
• TUN
Select the VPN protocol you need. Available protocol are:
• UDP
• TCP
Holds the Talk2M-Pro Account name used by eWON.
Holds the name or IP address of the Talk2M Access Server you want to use.
Some place holders names are defined:
• talk2m_free_eu This is the European Talk2M Free Server, used by all account created before June 2009 and this is the default Talk2M Free Server.
• talk2m_free_us Used by people who created there account on the Talk2M Free server located in the USA (server launched in June 2009).
• talk2m_pro This is the Talk2M PRO master access server.
Table 38: VPN Global parameters
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 49
General Reference Guide eWON Configuration
The eWON can be set to "listen" to incoming connections, you may connect directly your computer (or another eWON) to an eWON and establish a secured VPN channel.
Control
Passphrase
VPN IP addresses config
Figure 39: VPN Incoming setup page
Description
Enter the passphrase that will be used as certification for the incoming connection.
Choose between automatic/Manual
Automatic: the IP addresses used will be set automatically
Manual: the IP addresses used are defined statically with the 2 following parameters.
IP address taken by eWON (in manual config)
IP address taken by the remote device, PC or eWON, (in manual config)
Local VPN IP address
Remote VPN IP address
3.3.4.2.4.1
Outgoing VPN
Outgoing VPN can work in three schemes:
• build a VPN connection between two eWONs
• connect to a VPN Server to join a VPN Network
• connect to an eFive (*) VPN server
(*) Note: The settings to connect to the eFive Server apply the same way to the formerly marketed Endian VPN servers.
Both are compatible.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 50
General Reference Guide
VPN between two eWONs
As shown below, the Remote VPN WAN address or name field has to be set to Defined manually (6).
This parameter is for Talk2M use only.
eWON Configuration
Figure 40: VPN Outgoing setup page (connect to other eWON)
Control
Remote VPN WAN address or name
Primary Server
Secondary Server
Passphrase
VPN IP addresses config
Local VPN IP address
Remote VPN IP address
Description
Connect to...OTHER eWONs
Field to be set to Defined Manually
This field is for Talk2M use only.
The address or Name of the primary VPN Server
The address or Name of the secondary VPN Server (called if primary failed)
Enter the passphrase that will be used as certification for the outgoing connection.
Choose between automatic/Manual
Automatic: the IP addresses used will be set automatically
Manual: the IP addresses used are defined statically with the 2 following parameters.
The IP address taken by eWON (in manual config)
The IP address taken by the remote device, PC or eWON, (in manual config)
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 51
General Reference Guide
VPN with a Server
For Talk2M configuration you can skip this screenshot and go to the next one.
Without Taklk2M (Taklk2M wizard not executed) the screen looks like this: eWON Configuration
Figure 41: VPN Outgoing setup page (connect to VPN Server)
Control
Remote VPN WAN address or name
Primary Server
Secondary Server
Private key eWON Certificate
CA (Certificate Authority)
CERTIFICATE
Description
Connect to...VPN Server
Field to be set to Defined Manually
This field is for Talk2M use only.
The address or Name of the primary VPN Server
The address or Name of the secondary VPN Server (called if primary fails)
Place here your Private KEY
Place here your eWON CERTIFICATE
Place here your CA CERTIFICATE
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 52
General Reference Guide eWON Configuration
Note for Talk2M users: This is the interface showing the configuration parameters for a VPN connection through Talk2M. When the Talk2M wizard of the eWON is used, these fields are populated automatically and require no special attention. Important! The field Remote VPN WAN
adress or name is required. It is automatically set to Talk2M defined when running the Talk2M wizard. This field is meant to have the possibility to change server afterwards either changing from free to pro account, for maintenance purposes, or for any reason that would make that the server would be temporarily unavailable.
Figure 42: VPN Outgoing setup page (connect to Talk2M VPN Server)
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 53
General Reference Guide eWON Configuration
VPN with an eFive (*) Server
This is the interface showing the configuration parameters of a VPN connection to an eFive Server. When the eFive configuration wizard of the eWON is used, these fields are populated automatically and require no special attention. Important! The Remote VPN WAN address or name field was set by the wizard to Defined manually. This setting is for Talk2M use only.
Figure 43: VPN Outgoing setup page (connect to eFive VPN Server)
Control Description
Connect to...eFive VPN Server
Remote VPN WAN address or name
Primary Server
Secondary Server
Username password
CA (Certificate Authority)
CERTIFICATE
Field to be set to Defined Manually
The address or Name of the primary eFive VPN Server
The address or Name of the secondary eFive VPN Server (called if primary failed
Place here the user of the VPN account
Place here the password of the VPN account
Place here the CA CERTIFICATE of the eFive VPN Server
(*) Important Note: The above settings referring to the eFive server from eWON apply since firmware version 6_4S6. Before this firmware version, they reffered to the ENDIAN server. The same settings work for both products. This means that it is possible to connect to an eFive server with an older firmware version where the interface still shows ENDIAN. The same way, a newer firmware showing eFive can be used to connect to an ENDIAN server.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 54
General Reference Guide eWON Configuration
3.3.4.2.5
WAN/LAN/PPP interface management
Thanks to its 2 ethernet interfaces (2005/4005), since firmware 5, the eWON makes a strong distinction between the WAN interface and the LAN interface.
3.3.4.2.5.1
LAN (Local Area Network)
In the eWON, the LAN is the ethernet interface connected to a local network.
It is simply an ethernet interface with no specific properties.
3.3.4.2.5.2
WAN (Wide Area Network)
In the eWON, the WAN is the (ethernet) interface connected on Internet.
That means:
- WAN could be an ethernet or an outgoing modem (PPP) connection
- WAN is active only when the connection is pulled up
- WAN has some properties like:
• Being able to publish its IP address
• Being able to establish VPN when WAN is active
• Can be configured for NAT and Transparent Forwarding
• Being protected according to the configuration
• Can be configured for Static Routes
• Can be configured for Proxy rules
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 55
General Reference Guide eWON Configuration
Ethernet WAN Connection - Disconnection sequence (since firmware 5.4)
Connection:
- Ethernet WAN interface is pulled up (the Link Led will lighten if a cable is connected)
- Apply DNS server change if valid
- Configure the Default gateway for the interface if valid
Disconnection:
- Remove the default gateway if it was configured during connection
- Pull down the Ethernet WAN interface (the Link Led will go off)
- Remove the DNS configuration if it has changed
Since firmware 5.4, the WAN Link Led behavior depends on your configuration.
It is not only hardware related.
By default, the WAN Link Led is off even if a cable is plugged.
Since firmware 6.2, the default communication configuration of the Ethernet WAN is static AND with the Internet "Maintain connection" enabled. This allow the WAN Link Led to be ON when you plug the cable.
Ethernet WAN permanently activated (before firmware 5.4)
Before revision 5.4, the WAN Ethernet interface was configured during eWON boot time. When the Internet connection was "activated" by the
WAN management, the Interface configuration was not affected, only the gateway configuration was modified.
Since version 5.4, the WAN Ethernet interface is managed like the PPP interface i.e. it is pulled up when activated and pulled down when deactivated.
Consequently, the WAN Ethernet IP configuration can be changed and the new configuration will be applied the next time the interface goes up.
3.3.4.2.5.3
PPP (Point-to-Point Protocol)
In the eWON, the PPP is the Modem connection
This PPP connection could
- be an Incoming or Outgoing modem connection
- update the default Gateway of the eWON
- be considered as a WAN
Depending of the PPP connection type, the Gateway (GW) and/or the WAN are presents.
PPP connection type
default Outgoing connection
(eWON acts as PPP client)
Callback to "Primary/Secondary server"
Outgoing connection
(eWON acts as PPP client)
Callback to "User Defined Phone Number"
Outgoing connection
(eWON acts as PPP client)
Incoming connection
(eWON acts as PPP server)
Gateway
Yes
Yes
No
Yes (*)
Table 39: PPP: Gateway and WAN
(*) Only if "Use incoming for outgoing" is checked
WAN
Yes
Yes
No
No
3.3.4.2.5.4
Wake-UP SMS
If an eWON feturing a wireless phone receives a wake-up SMS containing the message Talk2MConnect, this eWON will trigger it’s Internet connection. Since firmware 7.0, the eWON will trigger the Internet connection on modem, even if the modem is not the configured as the normal way out to the make an Internet connection.
It is sometimes required to be able to fallback on a backup access in case the WAN network would be down. Provided the subject eWON is equipped with a GPRS modem, the user can trigger that modem to get an emergency connection when the WAN connection is down. The only thing the user needs to do is to send a wake-up SMS to the eWON and the connection will then be taken over by the GPRS modem. As soon as the user closes the GPRS connection, the eWON will make attempts to restore its normal WAN connection.
The syntax of the wake-up SMS is: "talk2MConnect" without quotes.
The wake-up SMS can be sent either from a mobile phone or from eCatcher through the Talk2M account.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 56
General Reference Guide eWON Configuration
3.3.4.2.6
Ethernet Gateway behavior
On the eWON, it is possible to define a default gateway on the ethernet interface.
First we must consider 2 cases.
• The eWON has 2 ethernet interfaces (2005/4005/2005CD/4005CD/2104/4104)
In this case, the gateway is active only while the WAN interface is connected.
The eWON-ADSL must be considered as an eWON with 2 Ethernet interfaces.
The ADSL interface is a WAN interface.
• The eWON has only 1 ethernet interface.
3.3.4.2.6.1
eWON with 2 Ethernet interfaces
• Normal behavior
The Ethernet gateway is configured only when the ethernet WAN connection is established.
The Ethernet WAN connection is established on demand when the eWON has no route for a packet, or always when the "Maintain connection" option is checked in the "Internet connection' configuration".
• Gateway during an incoming PPP connection
There is a special case when:
• WAN Ethernet connection is enabled
• Incoming PPP is enabled
• Use incoming for outgoing is enabled
In that case, when the incoming communication is received, the eWON will try to configure the PPP connection as the default gateway. This will happen only if the WAN connection is not enabled at that time.
So, if the PPP connection is established and the WAN connection is not active, the PPP connection becomes the gateway. If the WAN connection is active, then the PPP connection will not become the gateway.
3.3.4.2.6.2
eWON with 1 Ethernet interface
• Normal behavior
In that case, if a gateway is defined, it will become the default gateway only if the Internet access is set to "No internet access"'
If the "Network connection" is configured to something different from "No internet access", the Ethernet gateway will not become the default gateway, and a warning will be issued in the event log:
"Ethernet gateway not used (incompatible internet connection)"
• Gateway during an incoming PPP connection
During the incoming PPP connection, the default gateway is normally not changed, except if the 'Use incoming for outgoing' option has been selected.
In that case, the default gateway becomes the PPP connection during the incoming connection.
The default gateway is reconfigured to the Ethernet gateway when the PPP connection ends.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 57
General Reference Guide
3.3.4.3
Networking Config
The Networking Config section sets all the network behaviors of your eWON.
These behaviors are:
• How to connect to the Internet
• What is the VPN behavior
• Do I publish the IP address, do I use No-IP
• Callback
• Routing rules
• Proxy features
• Security features
• IP ports configuration
eWON Configuration
3.3.4.3.1
Internet connection
Control
Network connection
Maintain connection
Publish IP address
Re-publish interval
Figure 44: Internet connection setup page
Description
Internet access
Set here how eWON will connect to the Internet. Choose among the 3 choices:
• No Internet access
• Modem Connection
• Ethernet WAN connection (or ADSL)
Set this checkbox if you want a permanent connection to Internet. The eWON will monitor the connection and re-establish it if the line is dropped.
Publish WAN IP address
Enable or disable the publication of the WAN IP address of the eWON.
See "Publish IP address" on page 60 for configuration parameters.
Set the time interval for the re-publication of the WAN IP address.
Table 40: Internet connection parameters
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 58
General Reference Guide eWON Configuration
Dial On Demand
"On demand" Internet connection
It is possible to establish remote connections towards the ISP by using the Dial On Demand feature. If selected, the eWON will try to connect to the ISP each time a connection will be required (i.e. packets to send). Those fields allow you EITHER to exclude OR to select IP addresses ranges that are allowed or refused for Dial On Demand. Four different IP addresses ranges can be defined.
Note: those fields will be updated at each new PPP connection.
Important: By default, the Dial On Demand is configured to refuse all connections.
Table 40: Internet connection parameters note: If Network Connection is on Ethernet WAN connection, the Ethernet interface is not active as long as the WAN is not connected.
See "Ethernet WAN Connection - Disconnection sequence (since firmware 5.4)" on page 56
note: If Network Connection is on ADSL, and you want to allow devices connected on the eWON-LAN to go on Internet, don’t forget
to set the Routing to NAT and TF on WAN (See "Routing" on page 63).
3.3.4.3.2
VPN connection
Figure 45: VPN connection setup page
Control
During Internet connection
Description
VPN use conditions
Set here how eWON will use the VPN. Choose among the 3 choices:
• Disable VPN
• Listen for incoming VPN from Client
• Establish outgoing VPN to server
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 59
General Reference Guide eWON Configuration
3.3.4.3.3
Publish IP address
When the eWON goes to the Internet (automatically or by CallBack) , it can receive a different IP address at each connection. It needs to inform you of its new WAN address thanks to this publish IP function.
Figure 46: Publish IP address configuration page
Control
EMail destination address
Dynamic DNS Provider
Description
Publish by EMail
This field allows you to define the destination address by default that will receive the notification.
Publish by dynamic DNS
Choose your Dynamic DNS provider among the list beside
A Dynamic DNS provider are services that allows you to publish on the Internet a domain name that matches the IP address of your PC (fix or dynamic type).
Dynamic DNS Username
Dynamic DNS password
Dynamic DNS Host name
Dynamic DNS Domain name
Debug connection
Put here your Username.
This field allows you to enter a valid password for the
Dynamic DNS server you want to use.
This field allows you to enter a valid host name for the
Dynamic DNS server that you want to use e.g. myewon.
This field allows you to enter a valid domain name for the
Dynamic DNS server you want to use e.g. no-ip.com.
In our example, your eWON will be accessible at
http://myewon.no-ip.com
Check it to record debug info about DynDns negociation in the "Diagnostic->RealTimeLog" page.
You need to to check the Enabled AND select NO-IP as dynamic DNS to access parameters.
Otherwise, you will see the page like this:
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 60
General Reference Guide
3.3.4.3.4
Callback
Warning: depending on your eWON's version (c.f. Table 198 on page 209)
This menu contains the configuration controls that the eWON will use to perform callback operations.
eWON Configuration
Control
Callback enabled
Callback delay
Wait for user login for
Dialup account
Publish IP address
Figure 47: Callback configuration
Description
General Callback Config
If this box is checked, then the eWON callback feature is enabled. This means that the eWON can be triggered by an external event in order to call a given phone number in order to establish a PPP link.
This permits to let the eWON’s phone line pay for the call, with a budget maintained by the eWON itself. This also ensures more security if you are calling back a private server. Do not forget to enable outgoing calls in the dialup configuration.
Once the eWON has been triggered, it will wait for this amount of time before dialing out. This is useful in order to release the phone line or perform any other action.
Once the eWON has been triggered, it will wait for this amount of time in order for the user to log-in.
Otherwise, the call is dropped. It is clear that this delay has to be greater than the sum of the callback delay and the call establishment.
This list box permits to choose the server used for callback. The "User’s request account" option can not be chosen when the trigger mode is "Ring", because the eWON does not know the server data at this time.
Enables/Disables the publication of the IP address once the eWON is connected to the Internet.
The publishing parameters are defined in the "Publis IP Address" menu (previous chapter).
Callback mode: ON RING
Number of RINGS
Plus number of RINGS then On Hook
Callback mode : ON User’s request
This is a mutual exclusive option with Callback on User’s request. Selecting this option disables the
User Callback mode. When the eWON sees an incoming call, it will trigger its callback task.
(minimum value is 2): This is the number of rings needed before the eWON callback function is triggered. Assuming that a value of 3 has been entered, the eWON will generate a callback if someone calls the eWON and lets the phone ring 5 times.
(minimum value is 5): This is the number of rings that are necessary to avoid the callback trigger.
Assuming that a value of 5 has been entered, if the user tries to call the eWON directly, this can be achieved by ringing the phone more than the sum from the two values. With the current example, the eWON will pick up the line after more than 3+5=8 rings are detected.
When this option is selected, the eWON accepts the incoming calls and then the user can request a callback to a defined server.
When connecting to an eWON with Callback on user's request, you will get the following webpage.
You will start the callback by using the Callback button or abort (hang up the phone line) by using the
"Close PPP Connection" button.
The callback can be performed with the parameters specified in the user’s configuration page. The delay the eWON will wait before initiating the callback can be specified.
Table 41: general callback configuration controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 61
General Reference Guide eWON Configuration
Figure 48: Callback on user’s request at logon
Note: When connecting to an eWON with Callback on user's request, you will get the above webpage.
You will start the callback by using the Callback button or abort (hang up the phone line) by using the "Close PPP Connection" button.
Please check the callback configuration that has been defined in the user's configuration (see the below screenshot ), especially if you enable the
"Callback on user's request" checkbox in the callback configuration window.
Figure 49: eWON User callback setup
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 62
General Reference Guide eWON Configuration
3.3.4.3.5
Routing
This page contains the router configuration of the eWON, the PPP settings for the server and client functions of the eWON engine, in order to define the way that you will use your eWON to access remote devices, and access them through the eWON as if they were on your local site.
Figure 50: Routing setup page (on eWON 2005CD, 4005CD, 2101CD, 4101CD, 2104CD, 4104CD & Flexy 20x with WAN Extension)
Control
Route all gateway traffic through
VPN
Apply NAT and TF to connection
Enable transparent forwarding
Highest transparent forwarding port
Description
Special rules
Check this box if you want to route ALL gateway traffic (expect static routes) through the active VPN interface.
If unchecked, the traffic could take the VPN route or the WAN route (uncrypted).
NAT and Transparent Forwarding
This feature enables the Network Address Translation (NAT) and Transparent Forwarding
(TF). If the device to reach is on the same LAN as the eWON, and if the user has correctly defined the address IP and the port for this device, then the eWON will redirect the packets towards it. This means that only the packets for the concerned port will be redirected towards the selected IP address.
You can choose on which interfaces this NAT and TF will be used: LAN (Plug’n Route),
VPN, WAN or disable it.
If this box is checked, the transparent forwarding feature of the eWON is activated (see below for Transparent Forwarding definition).
Only a range of ports are forwarded transparently.
You can control this range, from 0 to 32767 (Default is 10000).
The above Ports will be directed to eWON itself.
Exception: to allow to come back to the eWON website, the port 81 (by default) is excluded from this range.
note: If Network Connection is on ADSL, and you want to allow devices connected to the eWON-LAN to go to the Internet, you must set the Routing to NAT and TF on WAN.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 63
General Reference Guide eWON Configuration
Figure 51: Routing setup page (on eWON 4001, 4002)
The IP Forwarding configuration check box enables the forwarding between both interfaces (LAN and PPP).
On eWONs with VPN (*), this check box does not appear because IP Forwarding is always active.
(*) Irrelevant for the Flexy 1xx types that have VPN but no routing capability.
Term
IP forwarding
NAT
Transparent forwarding
Definition
This means that a link can be performed between PPP and Ethernet IP packets. Please note that this is dangerous because it can connect your LAN directly to the Internet.
This feature can be used in order to connect a device to the Internet through the eWON. For example, if an automaton is connected to the Ethernet LAN of the eWON and has the eWON
IP address as gateway address, the eWON will perform anything needed in order for the device to send its packets (dialout, IP translation …). Example: a device sends a mail on the
Internet, while the eWON performs the PPP dial-out.
Another use is to access a device located on the Ethernet LAN of the eWON, the user directly calls the eWON and then gets access to its distant device through its LAN IP address.
Example: a user on a LAN with IP address range 192.168.0.xxx can access its device on the eWON LAN, with the eWON IP address 10.0.0.81 and the distant device with IP 10.0.0.82 and having the eWON as a gateway. The eWON will for example assign the IP address
202.0.0.1 to the PPP adapter of the PC and take for its PPP adapter the IP address
202.0.0.240.
Network Address Translation (NAT).
If the device to reach is on the same LAN as the eWON, and if the user has correctly defined the address IP and the port for this device, then the eWON will redirect the packets towards it.
This means that only the packets for the concerned port will be redirected towards the selected IP address. IP Forwarding must be activated for NAT to be active.
For this to work, the IP forwarding must also be enabled. With simple IP forwarding, it is not possible to access a device located on the eWON Ethernet LAN through the Internet. For example if the eWON is connected to the Internet through PPP (for example on alarm), it publishes its IP address by email. In order to have access to its device, the user cannot simply type the IP address of the device like this was done with IP forwarding and direct eWON call.
In this case, transparent forwarding is the only solution: when accessing the eWON, the user can request to perform transparent forwarding once he logs in. He can then see the window that is illustrated by the screenshot below this table. If the device is on the same network as the eWON and gets the eWON as gateway, and if the user configured the IP address of the device at eWON login, the eWON routes all packets to this device.
This means that all IP packets, on all ports except 81 will be routed transparently to the selected IP address. In order to get access to the eWON web server, the user has to connect to port 81 of the eWON IP address. For example http://10.0.0.53:81 will access the eWON main page, while 10.0.0.53 will access the IP address 10.0.0.56 of the device located onto the
LAN if the user selected this IP at logon. The user can clear transparent forwarding by getting access to the port 81 and using the "Clear transp forwarding" button. Note that FTP cannot be routed, since it includes the target IP address in its frame in text mode.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 64
General Reference Guide eWON Configuration
Figure 52: eWON PPP Router logon screen
3.3.4.3.5.1
Static routes
Before the firmware 5.2, it was only possible to configure a default gateway to reach a given destination node when not located on the eWON's physical network.
This feature adds the ability to configure 3 additional entries in eWON's routing tables (static routes).
The eWON will forward packets using these routing entries when the IP packet destination matches one of the routing destination entries. The default gateway if specified will only be used when no routing entry matches the destination.
Control
Destination & Mask
Gateway
Hops
Clear (button)
Description
Static routes table
The destination IP address and the mask represent a range of addresses that must be routed through a specific gateway.
ex: dest=192.168.1.0 & mask=255.255.255.0 correspond to the range of address between
192.168.1.0 and 192.168.1.255
This is the IP address of the gateway that must be used to route the range of address defined by Destination/Mask.
Important: the Gateway address must be in the IP range of the eWON interface.
In other words, the Gateway must be accessible by the eWON.
For example if the IP address is 10.0.0.53/255.255.255.0, the gateway can be 10.0.0.254, but it CANNOT be 192.168.1.1.
This is the number of hops to reach the destination using the given route. This parameter will define the priority of the routes. The eWON local routes (routes that do not require the emission of a packet through an interface) have a 0 hop metric. A route where the destination can be reached through the interface has a 1 hop metric.
The higher the metric is, the lower the route's priority will be.
The clear button can be used to invalidate the route entry content and remove the route.
Important: The route configuration is applied immediately when the update button is pushed. It is not required to reboot the eWON to apply the routes modification.
note: The default gateway is NOT defined using these configuration variables (Ethernet Gateway is used instead).
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 65
General Reference Guide eWON Configuration
3.3.4.3.6
Proxy
3.3.4.3.6.1
Why a proxy feature?
Since firmware 5.2, the eWON has a built-in ProxyServer.
The Proxy feature is similar to the transparent forwarding, with some advantages and some drawbacks.
To be precise, it is not exactly equivalent to the transparent forwarding that forwards all the ports (except the 81), but more like a "port forwarding" feature that would forward some ports.
The main advantage of the proxy implementation is that the "proxy's destination device" must NOT define the eWON as its gateway.
3.3.4.3.6.2
Comments on the proxy feature
• Overhead
There is an important difference between a forwarded packet and a proxied packet . When the packet is forwarded, it is modified at a very low level of the stack, then it is immediately resent without any further interpretation, manipulation or storage.
When the packet is proxied, the stack must first maintain storage for the proxied sockets, then every packet must walk the stack all way up to the proxy application, then all the way down to be resent.
This means an additional load for the system.
• Proxied ports must be known and configured
In "Forwarding" mode all ports are forwarded, there is no need to configure anything.
In Proxied mode, the user must know what port(s) he wants to forward and what protocol (UDP,TCP, FTP) will flow on the port.
• More intrusive content
As said before in "Forwarding" mode, the packet is resent "as received". If it contains 4 bytes, 4 bytes are resent. This is not true in the proxy mode as the received data are (at least may be) re-aggregated at the proxy level.
Example: if the client sends a 4 bytes packet followed by a 2 bytes packet, then the proxy can resend a 6 bytes packet to the "proxy's
destination device". From a TCP point of view, there is no difference, but from a behavior point of view, there is a slight difference.
One must check what protocol are considered here with the "proxy's destination device" and check if there is a chance that the proxy may disturb the client-"proxy's destination device" discussion.
3.3.4.3.6.3
Configuration.
Figure 53: Proxy configuration page
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 66
General Reference Guide eWON Configuration
All these parameters are in the comcfg.txt file.
Control
(param name in comcfg.txt file)
Proxy Configuration Enabled
(ProxyEnabled)
Idle connection timeout
(ProxyIdleTO)
Description
Enables or disables the proxy feature. The proxy operation can be switched on or off at any time during the eWON operation without reboot.
Any change in the configuration is applied as soon as the configuration is changed.
Each time a client opens a connection to the proxy, the connection is kept opened until the client explicitly closes it or until this timeout is elapsed without data being transferred on the socket.
This is required if a client is for example switched off while the connection is active, the connection will be dropped and the memory recovered after the timeout is elapsed.
Maximum connections per proxy enrty
(ProxyMaxSock)
Proxy External Interface (EXT)
(ProxyExtItf)
For each proxy entry, a maximum number of connections can be opened at a given time on a proxy port. This parameter defines the maximum.
Select the interface (WAN, PPP incoming or VPN) where the proxy rules are applied.
Table 42: Proxy Global parameters table
Control
(param name in comcfg.txt file)
Description
Protocol
(ProxyProto#)
Direction
(ProxySide#)
Incoming port
(ProxyPort#)
This is the type of protocol that the eWON will proxy to the given server. These protocols are handled differently and must be specified in the configuration.
Available protocols are :
• Disabled (0)
• UDP (1)
• TCP (2)
• FTP (3)
Although FTP is TCP, it must be specified. The FTP proxy will work for passive and active connections.
REM: If ProxyProto is set to "disabled", then the full proxy entry will be disabled, regardless of the other entry parameter's values.
The eWON's proxy is completely symetric, it can work in both directions.
Usualy the user will want to proxy from the EXT to the LAN in order to access a device on the
LAN that has not the eWON as gateway.
But a device can also connect to a server on the EXT without having the eWON as gateway.
This is true as long as the server has a fixed IP address that can be entered in the Proxy configuration.
Available directions are :
• Disabled (0)
• EXT to LAN (1)
• LAN to EXT (2)
REM: If ProxySide is set to "disabled", then the full proxy entry will be disabled, regardless of the other entry parameter's values.
Port number on which the eWON will listen.
For example, if the eWON must forward ports on a web server on port 80 and the client will connect to the eWON on port 8080, then incoming port (ProxyPort)=8080 and Destination
port (ProxySrvPort)=80
Destination port
(ProxySrvPort#)
Port number on which the eWON will connect when it receives a connection from the proxy client. This port will be the server port on device with the Destination IP address.
Destination IP address
(ProxySrvIpAddr#)
The IP Address of the server the eWON will connect to when it receives a connection on its proxy port (ProxyPort).
REM: If the Destination IP address is set to 0, then the full proxy entry will be disabled, regardless of the other entry parameter's values.
Table 43: Proxy Entry parameters table
Note: There are 10 Proxy Entries, the # character found in the table above represent the index of the proxy entry, first entry has the index 1 (i.e.: ProxyProto1), the last entry has the index 10 (i.e.: ProxyProto10).
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 67
General Reference Guide
3.3.4.3.7
Security
You can define the Networking security level you need.
You can set security at three levels: WAN level, VPN level and at Transparent Forwarding level.
eWON Configuration
Figure 54: Networking security page setup (with VPN Protection disabled)
Figure 55: Networking security page setup (with VPN Protection enabled)
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 68
General Reference Guide eWON Configuration
Control
WAN Protection level
Description
WAN Protection
• Discard all traffic excepted VPN and initiated traffic (like outgoing eMail or putFTP)
• Discard all traffic excepted VPN and initiated traffic and ICMP (Ping)
• Allow all traffic on WAN connection (no protection)
WAN IP Forwarding
Require authentication
The default value is enabled, if disabled, then the LAN traffic cannot be forwarded to the
Ethernet WAN interface.
This option will disable forwarding only when WAN is configured on Ethernet or ADSL interface.
VPN Protection
"Allowing Rules" could be transmitted to the destination.
Source IP
Destination IP range start
Enter here the Source IP address which is allowed to reach the LAN.
Only one address could be encoded (ex: 10.8.12.56).
Special value: 0.0.0.0 to disable the rule
Special value: 255.255.255.255 to allow ALL Source IP addresses
Enter here the start of the destination IP addresses range reachables (ex: 192.168.0.100)
Special value: 0.0.0.0 replaces eWON’s LAN or VPN IP addresses
Special value: 255.255.255.255 to allow any Destination IP addresses
Destination IP range end
Destination Port
Enter here the end of the destination IP addresses range reachables (ex: 192.168.0.125).
Enter here the ports allowed. Separate values by comma to enter several ports (80,81,502).
Special value: 65535 to allow ALL ports
Transparent Forwarding
If this box is checked, the eWON will only accept to forward packets coming from the user who initiated the communication.
Table 44: Networking Security parameters
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 69
General Reference Guide eWON Configuration
3.3.4.3.8
IP Services
This page allows you to redefine the standard eWON's ports.
The main interest of this feature is to be able to go through a firewall when all the ports with value less than 1000 are blocked for access over this firewall.
Figure 56: IP Services configuration
Control
Primary HTTP port
Secondary HTTP port
TCP command Port
Description
HTTP Web Server
Allows you to redefine the eWON's Primary TCP Port (whose default value is set to 80).
Allows you to redefine eWON's Secondary TCP Port (whose default value is set to 81).
This port is never forwarded when Transparent Forwarding is enabled.
This port is used to reach the eWON default Website ( http://10.0.0.53:81 )
FTP Server
Allows you to redefine the TCP command Port from eWON's FTP Server (whose default value is set to 21).
Table 45: IP services configuration controls
Validate your changes by clicking on the Update button. The changes in those fields will be taken in account only after the eWON is rebooted.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 70
General Reference Guide
3.3.4.4
Manage Config
In this group, you will find parameters and functions allowing you to manage your eWON configuration.
3.3.4.4.1
Security
eWON Configuration
Control
Encrypt sensitive data eBuddy needs authentication
Figure 57: Manage config : Security setup
Description
Select this box to encrypt sensitive data (passwords, Pin code) in setup page and configuration files. The text appears as dots in the Input Field (see image below).
In configuration files, the password values are crypted too (see comcfg extract below).
If this box is clear, the password is readable in the Setup page and in the configuration files.
Select this box to accept an IP address change from eBuddy only with authentication (since firmware 6.0). The eWON User needs to have the "Change Configuration" right.
This feature requires eBuddy 1.8 (or above)
Figure 58: Encrypted Fields
3.3.4.4.2
Default Config
Using this menu, the user can return to the default communication configuration of the eWON. This will NOT modify anything in the other configurations of the eWON. The IP address will not be modified. This option requires a forced reboot of the eWON (software or hardware).
Also remember that the communication setup is NOT affected by a format of the eWON.
RG-001-1-EN rev. 2.1
Figure 59: Reset to default COM config
eWON® - 14/01/2014 - ©eWON sa Page 71
General Reference Guide eWON Configuration
3.3.4.5
Storage
The eWON stores configuration and recording data in its flash memory.The eWON flash memory is divided into areas of different sizes that can be erased and reformatted individually during a partitioning operation.
Depending on their type, eWONs have physical flash memory sizes of 8, 16, 32 or 128 MB. However, not all that physical memory is available for the user, see table below.
eWON types
eWON500 V1 eWONx001 eWON4002 eWON500 V2 eWON4001 V2 eWONx005 eWONx101 eWON4102 eWONx001CD eWONx005CD eWONx104 eWON Flexy 10x eWON Flexy 20x
Physical Flash Size
8 MB
16 MB
32 MB
128 MB
Table 46: eWON types vs flash memory
User Memory
4 MB
7 MB
17 MB
35 MB
3.3.4.5.1
Memory config
Depending on the memory size of the eWON you are working with, you can select either 3 or 5 different memory partitions. The selection of a particular partition depends on the specific needs of your application. In the example below, we consider the partitions available for eWONs featuring a physical memory of 16MB. Next to the radio button selection, the active configuration is displayed in RED .
Figure 60: Memory config page (16MB physical, 7MB available)
/usr
(MB)
6
5
4
Rec.
(MB)
1
2
3
Requirements towards of your eWON
You want to store a lot of user files on your eWON, but you won't create a lot of Tags.
You will store a lot of user files AND you will define a lot of Tags in your eWON.
You won't store a lot of user files on your eWON, but you will define a lot of Tags on it.
Table 47: storage configuration examples of use
Warning
: Changing the storage configuration implies reformatting the available memory space. This means that all data, except the communication configuration, will be lost.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 72
General Reference Guide eWON Configuration
Note: The storage configuration that you define in this panel is applied only after the eWON’s reboot. Therefore, changes made to the configuration can be cancelled at any moment, provided that the eWON was not rebooted in the meantime. Imagine that you change your configuration (i.e. you selected configuration 3 while you are currently running configuration 2... As long as you have not rebooted eWON, you can return to configuration 2. In this case, there will be no change applied in the Storage Configuration when eWON reboots. You have just to check that you select the line in which characters are displayed in red, and validate by clicking on the Update Config button.
Figure 61: Storage Memory config page (8MB)
Description of the fields appearing on the example of storage config page above:
Flash Memory zone
/usr size
Recording size
Number of points
(Hist. Rec.)
Number of events
Number of alarms hist.
/sys size
Size
1 to 16
MB
1 to 3
MB
As per table
As per table
As per table
0 to 1
MB
Circular
No
Yes
Yes
Yes
Yes
No
Description
This partition uses a different file system, allowing to create a larger number of files and to use a larger total flash memory. This file system is also very robust in case of power lost during the time when operations are performed on the files. This partition can be used through the eWON’s FTP server or using the eWON’s BASIC scripts. If the /sys partition does not exists, the program and the configuration are then stored in this partition (see below: /sys partition).
This partition contains the 3 files containing circular data:
• Incremental recordings
• Events logging
• Alarm history logging
Each of those files receives a predefined maximum amount of space. When the space is full, then the older data are erased, in order to free space for the new data. The number of records depending on the selected partition are liste in the 3 next colums, to the right.
Indicative capacity in number of points, as a subset of previous partition "Recording size"
For a given eWON, this number is depending on the storage config.
Indicative capacity in number of events, as a subset of previous partition "Recording size"
For a given eWON, this number is NOT depending on the storage config.
Indicative capacity in number of alarms, as a subset of previous partition "Recording size"
For a given eWON, this number is NOT depending on the storage config.
This partition uses the same file system as the /usr partition described above.
Its function is to store the program and the configuration. The configuration includes all the information that appear in the config.txt file. When this partition is formatted, the configuration and the program are erased, but the current configuration and program are still in memory. If the eWON is rebooted at that moment, it will use after restarting a default configuration and an empty program. When the configuration or the program are saved, the eWON uses this partition to save a config.sys and a program.sys files. These files are used internally by the eWON and should not be modified by the user. If the partition size is set to
0 MB (eWON with only 8MB), then the partition is not created, and all /sys data are saved in the "/usr" partition.
Important remark regarding circular files: This kind of file has 2 sizes, a standard size and a maximum size. When the maximum size is reached, the oldest 64K of data are erased and new data starts to be written. This means that the actual size of data that has to be considered for a circular file is the standard size, because the maximum size is not permanent.
Formatting the Flash file system means erasing all the data in these files.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 73
General Reference Guide eWON Configuration
Description of the other storage partitions (not available to the user)
Flash Memory zone
System Config
(except COM config)
Program
Communication
Config
Retentive values
Size
256 KB
128 KB
64 KB
64 KB
Circular
No
No
No
No
Description
The System configuration contains:
• System setup
• Pages setup
• IO Servers setup
• Tags setup
• Users setup
Script program
The communication configuration needs to be saved in a distinct block in order to allow formatting any other data in the eWON without risking to loose contact with the device
(Ethernet IP address, PPP configuration etc.). This configuration uses a fixed memory size and is stored with a special mechanism that prevents loosing the configuration even if power is lost at any time during the configuration update. The only risk is to loose the last modification made after last save occurred. Communication Configuration consists in all the configuration information that appears in the ComCfg.txt file.
This is a fixed flash memory block that contains the retentive values. Each time a retentive value changes, a record is written in the flash memory, the record is 12 bytes long.This file is also erased when the flash file system is formatted.vThe flash memory can be erased/ written minimum 100K times. Each time a retentive value is written, its record is read back and content is verified, in case of error, error code "Write retentive failed", code 20517 is generated, it indicates that the flash memory is probably dead. The dimension of that block does not need to be modified.
3.3.4.5.2
Erase & Format
Figure 62: Erase & Format panel
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 74
General Reference Guide eWON Configuration
This control panel function is to allow you to erase some parts of the eWON storage area.
Control
Format All partitions
Format /sys partition
Format /usr partition
Erase config
Erase program
Format Historical Recording File
System
Erase "Historical Recording" file
Erase "Events" file
Erase "Alarms History" file
Clear pending actions
Password required
Description
Format All partitions
Validating this checkbox will result in formatting /usr and /sys partitions.
Validating this checkbox will result in formatting /sys partition.
Validating this checkbox will result in:
Formatting only /usr if /sys is not stored in it
Formatting /usr AND /sys if you have chosen a storage configuration with /sys set to "0"
Erase config files
Validating this checkbox will result in erasing the eWON configuration, except for its communication information (comcfg.txt). Clicking on Execute after having selected this checkbox will disconnect you from your current eWON session.
Validating the checkbox will result in erasing the eWON Basic script file program.bas.
Format Historical Recording File System
Validating this checkbox will result in erasing the 3 files that stores the eWON’s internal history, which means all of the three following controls together in this table.
Validating the checkbox will result in erasing the binary format ircall.bin file that contains the binary values of all the Tags that are defined in the eWON.
Validating the checkbox will result in erasing the text format events.txt file that contains the history of all of the (maximum) 762 last events that have been logged in eWON.
Validating the checkbox will result in erasing the text format hst_alm.txt file that contains the history of the alarms for the Tags that have been defined in the eWON.
Clear scheduled action
Validating this checkbox will result in erasing from the sstat.htm file the eWON actions that are not currently in progress, that means all the actions that are completed (whatever successful or not).
Note: as sstat.htm is a "virtual" file, which means that its information are stored in the volatile memory from eWON, clearing this file does not impact the memory file system from eWON.
As this command is an exception in this page, it has been placed here for obvious ergonomic reasons.
Confirm operation
Your password is required in order to confirm your changes. Those changes will be validated when you click on the Execute button.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 75
General Reference Guide eWON Configuration
3.3.4.5.3
Tabular config editor
Since firmware version 6.4 S1, the eWON configuration parameters can also be accessed under tabular format. This feature should be used by advanced users only, you should not edit your configuration using the tabular editor unless you know exactly what you are doing.
The purpose of this topic is to explain how you can access and edit configuration parameters using the tabular config editor.
3.3.4.5.3.1
Access
Connect your PC with your eWON to access its web server. In the interface, click on Configuration, System setup and Storage. In the tree on the left, you have an entry called Tabular edition. If you expand the contents of this entry, you will see two additional links: Edit COM cfg and
Edit SYSTEM cfg. The eWON configuration parameters are spread over these two options.
Figure 63: Tabular configuration editor access
COM cfg = Communication settings, contents is equivalent to comcfg.txt file of the eWON.
SYSTEM cfg = general eWON settings, users, IOservers, etc. Contents is equivalent to the config.txt file.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 76
General Reference Guide
3.3.4.5.3.2
Edit parameters
Once you have clicked on one of these links, a list is appearing with ALL parameters that are available under this link.
eWON Configuration
Figure 64: Tabular list of the eWON SYSTEM cfg parameters
3.3.4.5.3.3
Searching for a given parameter
As there are many parameters, you may want to filter those that containing a given character chain. Therfore, just enter a search chain into the
Search field and hit Enter, a list showing only the matching records appears. Note: the example below shows a search on "NAT" which returns only one single parameter.
Figure 65: Result of a seach on parameters containing NAT in their identifier
Original Value corresponds to the value that is currently configured (saved) in the eWON (NOT the default value). Value shows the future value that will be send to the eWON when you click on Save. These values are typically identical when opening the interface.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 77
General Reference Guide
3.3.4.5.3.4
Editing the value of a configuration parameter
To edit the value, double-click on the selected record. The edit window opens: eWON Configuration
Figure 66: Edit value window
As soon as you change the value and click OK, this value appears in the Value column of the interface. It is however not yet written in the eWON.
It will be once you click on Save (typically after having edited all the parameters you need to change).
3.3.4.5.4
Features
Figure 67: Features setup page
There is some "options/restrictions" available on the firmware. To activate these features, you need to enter an "enable code".
3.3.4.5.5
REBOOT
Figure 68: eWON REBOOT Request page from the Storage menu
If for any reason you want to restart your eWON, then you just have to click on the REBOOT button, and the reboot process will begin.
Your eWON will be accessible again when restart is completed.
For further information on the different ways to reboot the eWON, please refer to chapter "Reboot" on page 15.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 78
General Reference Guide eWON Configuration
3.4 Tag Setup
3.4.1
Tag definition: Introduction
The eWON Monitoring Web Interface features are based on:
• The configurable monitoring of Tags
• The execution of scripts
All the variables monitored by the eWON are defined as "Tags". A Tag is a value changing with time and coming from a data-source.
Typical data-sources are:
• eWON internal Inputs/Outputs
• Remote Inputs/Outputs (modbus, UnitelWay, DF1, MPI, ...)
• eWON memory Inputs/Outputs (updated by script)
The data source is called an "IO Server". An IO Server is the interface between the changing value and the eWON monitoring engine. It is a kind of driver. Any variable from any data source must have a common representation for all IO Servers in order to define common interface in the eWON.
The data-source representation in the eWON uses 3 fields for the definition of a Tag:
• The IO Server Name
• The Topic name
• The Item Name
A Tag’s data-source will be uniquely identified with these 3 parameters.
IO Server name
Topic Name
Item Name
Is a kind of driver name. For each IO Server there is a specific Topic Name and Item Name syntax. The following drivers are available: MODBUS, EWON, MEM, NETMPI, UNITE
(Unitelway), DF1, FINS, S7 3&400(MPI), S7 200(PPI) and S5-AS511.
Is used to group items inside an IO Server, for example the memory an IO Server uses the blank topic ("") and the retentive topic ("ret"). All the Tags of the MEM IO Server defined in the
"ret" topic will have their value saved and restored when the eWON boots. All the IO servers do not use Topic Name. In that case Topic Name must be empty.
The item name is a string of characters; its syntax is specific to each IO Server. The Item
Name describes the physical variable to monitor using the IO Server.
Table 48: Tag’s data-source parameters
For example, the MODBUS IO Server needs to poll registers or coils from a slave, so it uses an item name representation to define the register type, register address and slave address. (Example "40001,5" => Where 4 means read write register, 0001 is the register number and 5 is the slave Modbus address).
Name, Topic Name and Item Name, it is given a Tag name that will be used everywhere in the eWON.
3.4.1.1
DataType of Tags
Internally, all Tags are stored on 4 bytes and represent:
• a single precision FLOATING POINT format (IEEE float representation)
• a DWORD, an unsigned 32 bits integer
• an INTEGER, a signed 32 bits integer
• a BOOLEAN, a binary value
In addition, an Automatic choice is provided to let eWON store the value of the tag in the best of the above DataTypes (depending of the IOServer register/ modifier type).
The DWORD and INTEGER types are available only since firmware 6.0.
Before firmware 6.0, all the tags were stored in single precision FLOAT format (IEEE float representation), and only 2 types were available
(Analog and Boolean). This means that you can only expect a maximum precision of 7 decimal digits.
That’s why, before Firmware6.0, the 32 bits Integer data read by an IOServer were automatically converted in the nearest float number representation.
For a huge number, it will mean a truncation (ex: integer value 1600000015 will be stored as float 1600000000.0).
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 79
General Reference Guide eWON Configuration
3.4.1.2
Tags validation
For optimisation purpose and since firmware version 5.2, the eWON can detect if tags are valid or not,
and disables the polling of invalid tags
.
By default, this feature is not activated, See "Global Config" on page 99 to enable it.
At the creation of the Tags or at the initialisation of an IOServer, all tags are considered as valid and are polled.
If repetitive errors occur on some Tags, these tags will be considered as invalid and will not be polled anymore !
A specific error message will be written in the event log.
This message is "Protocol Error while reading Tag (TagName - Polling disabled for this tag)" (see example in figure below)
Figure 69: Tag validation - error event
Invalid tags will be polled again when:
• the IOServer is started (i.e.: after a IOServer modification)
• a manual INIT of the IOServer (See "IO Server Init" on page 99)
• a modification of the Tag (in the I/O Server Setup part of Tag Setup)
3.4.1.3
Tags monitoring and handling
The eWON engine can handle the following operations on the Tags:
Operation
Alarm monitoring
Historical logging
Real Time logging
Modbus TCP publishing
Tag grouping
Script Access
Description
Check for low and high alarm levels or Boolean alarm level and management of alarm
acknowledgement, alarm historical logging and action on alarm (Email, SMS, etc.)
Tags can be monitored and changes on a Tag can be saved in the Flash File System.
Storage can be based on change threshold or at regular interval.
A Tag history can be kept in memory for an amount of time with a given time interval. This operation is volatile and does not involve any flash storage.
All the Tags can be given a Modbus address and can be read using the Modbus TCP protocol by and external modbus TCP master.
Tags can be organized by page and group for easier handling and viewing.
All the Tags values and attributes can be read or changed from script.
Table 49: Tags operations handled by the eWON
3.4.2
Tag definition: Setup
The Tag Setup page, reachable by clicking on the Tag Setup item of the Configuration menu, offer the possibility to build the eWON Tag’s dictionary.
The Tag name dictionary is the eWON central database where you have to define all the Input / Output (internal – available on the eWON – or external – through extension bus) that you want the eWON to monitor. If your Input/Output is not defined by a Tag, you will not be able to address it.
The Tag configuration includes two parts:
• The complete Tag configuration except for the actions to execute in case of an alarm.
• The alarm action list.
The first part of the configuration is accessed through the Tag hyperlink; the second part is accessed with the icon next to the Tag hyperlink.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 80
General Reference Guide eWON Configuration
Important: If a Tag is created in a different page than the page being displayed, it will not appear in the list, although it is present.
Figure 70: eWON Tag Setup page
• To EDIT a Tag
Click on the link in the Tag name column.
• To EDIT a Tag ALARM ACTION
Click on the icon next to name of the Tag link.
• To DELETE a Tag
Click on the check box near the Tag name and then click on the Delete Selected Tag link.
• To ADD a Tag
Click on the Create New Tag link.
If you want to create a new Tag that has nearly the same property as another Tag in the list, then validate the checkbox that stands at the left side of the "source" Tag’s name and then click on the Create New Tag link. Doing that, all field properties of the new Tag will be automatically filled with the selected Tag’s properties.
Note: "the first selected" means that if several Tags are selected, then the Tag that is cloned will be the first among the Tags that have been selected.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 81
General Reference Guide eWON Configuration
3.4.2.1
Tag main edit window
You will have access to the Tag main setup page by clicking on the Create New Tag link, or by editing an existing Tag when clicking on its
name (the content of this page differs accordingly to your eWON’s version: Historical Data Logging and Real Time Logging is not
available on all the eWONs): see Table 198 on page 209
Figure 71: eWON Tag main configuration page - eWONs that does not allow logging feature
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 82
General Reference Guide eWON Configuration
Figure 72: eWON Tag Main Configuration page - eWONs that allow logging feature
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 83
General Reference Guide eWON Configuration
Control
Tag name
Tag Description
Description
Tag general properties
Name of the Tag
The name of the Tag will be used for any reference to the Tag when using the export function or the script function.
-This Information will be included in the alarm email
Note: the Tag’s name cannot contain: spaces
$ character
" characters
Maximum length for a Tag’s name is 64 characters
A free text to describe the meaning of the Tag. Useful to clarify the meaning of an alarm.
-This Information will be included in the email that you can send on alarm.
Table 50: Tag’s general properties controls
Server Name
Topic Name
Address
Type
Force Read Only eWON value
I/O Server Setup
The IO server name is the Data source of the Tag name. Six data sources are available:
’eWON’ for all the eWON internal IO (please refer to chapter "The eWON IO Servers" on page 98)
’MEM’ for virtual IO used by script function (please refer to chapter "MEM IO Server" on page 143)
’UNITE’ for IO located on the extension bus (please refer to chapter "UNITE IO Server" on page 110)
’DF1’ for IO located on the extension bus (please refer to chapter "DF1 IO Server" on page 114)
’FINS’ for IO located on the extension bus (please refer to chapter "FINS IO Server" on page 121)
’S7200’ for IO located on an PPI bus (please refer to chapter "S7-200 (PPI - ISOTCP)" on page 151)
Used to apply a common configuration to several Tags.
Please refer to chapter "Tag definition: Introduction" on page 79
Please refer to chapter "Tag definition: Introduction" on page 79
Note: for memory Tag (MEM IO server) this field can be left empty. Although when editing a memory Tag, the Tag Name will be found here, this field is insignificant.
Defines the Tag name type: Floating Point, DWord, Integer or Boolean
See "DataType of Tags" on page 79.
Boolean only return value 0 or 1. If the IO server returns a value equal to 0, the Boolean value is 0. If the
IO server returns a value different from 0 the output value is 1.
Allows the disabling of the Update function in the View IO page. This is useful if you want to monitor a read/write Tag. The Tag is still read/write for BASIC operations.
Defines the offset and scale factor to be applied to the IO value coming from the server. The offset and scales are float values and negative values are accepted. The Tag value will be: TAGval = IOSERVERval
* scale + offset.
Table 51: IO server configuration controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 84
General Reference Guide eWON Configuration
Published value
Modbus TCP visibility
Register
Consider as float
SNMP Visibility
Instant Value
Tag Visibility
The value published by the eWON could be the same as the Tag value or could be modified with a scale factor and an offset.
Each Tag in the eWON can be accessed by a modbus TCP master. If the Tag must be visible: Enable this checkbox.
Address of the register, starting with 1.
Only the register address has to be specified, the type of Tag (coil, contact, Input register or Holding register) is obtained from the Tag type (Analog or Boolean) and the Tag Read Only or Read/Write property (obtained from the IO server).
If this option is checked, then 2 consecutive 16 bits registers will be reserved and the value will be output as a 4 bytes IEEE float in those 2 registers (standard Modbus float representation).
If the Tag is published as integer it may need to be scaled to fit the 16 bits modbus register. This operation will be applied to the Tag value to publish it.
If this is checked, the Tag can be seen by the SNMP manager. The OID of the Tag can be defined. The base OID is already defined, the only parameter is the end of the OID.
Allows you to group Tags into group (from A to D).
The Tag's instant values are stored in the inst_val file (available in txt and binary format from the Files
Transfer link from the Main menu navigation bar from eWON). The 4 checkboxes that match the groups that you want to choose will work accordingly to the $ft Export Block Descriptor Tag that is described in
Instant Value too.
Table 52: Tag visibility controls
’Alarm Enabled’
Check Box
Alarm level low
Alarm level high
Alarm level lowlow
Alarm level hihi
Value Dead band
Boolean Alarm level
Activation delay
Auto acknowledge
Alarm Hint
Alarm Setup
Check if you want to generate an alarm on the current Tag name.
Low "warning" threshold value for alarm detection.
High "warning" threshold value for alarm detection.
Low "danger" threshold value for alarm detection.
High "danger" threshold value for alarm detection.
The dead band is the difference between the alarm level and the RTN level (Return To Normal).
e.g. if the alarm value is 20°C with a DeadBand=1, the alarm is triggered when the Temperature crosses this 20°C boundary. On the other hand, the AlarmStatus will be RTN when the temperature passes below
19°C (20-1).
The alarm value ('0' or '1') of a Boolean Tag name –not applicable for analog Tag name-.
Time in seconds for which the Tag has to be out of threshold before declaring the Tag is in an alarm state. (This is mainly to avoid non significant alarms)
If checked, the alarm will be automatically acknowledged when the alarm state goes to RTN value. Thus, the alarm is directly ended.
Information related to the alarm action - This Information will be included on the alarm email-
Table 53: alarm setup configuration controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 85
General Reference Guide eWON Configuration
• Historical and real-time logging:
Those fields display only for some eWON's versions (c.f. "Tags monitoring and handling" on page 80)
Historical logging enabled
Logging dead band
Logging Interval
Real time enabled
Time span
Logging Interval
Historical and real-time logging
If checked, the Tag values will be logged in a circular file.
Warning: This is a non-volatile logging; data are stored in the flash file system. All the data are stored in the same file, the maximum number of values that can be saved is from 16384 to 139264, depending on the way you have set up the resources storage in the eWON (when maximum size is reached, then the older data will be erased first).
If one Tag "a" is recorded very often (every seconds) and another Tag "b" is recorded rarely (every day), you may have your Historical Log filled with a lot of tag "a" and few (or none) tag "b" because of the circular storage mechanism.
Defines the dead band of the Tag’s incremental recording (use a negative value to disable it)
Defines the interval, in seconds, for the Tag recording (set to zero to disable the logging interval).
Can be used at the same time as logging dead band.
If checked, the Tag values will be logged in memory.
Real time logging is different from historical logging because data are saved in a circular memory buffer.
The other difference with historical time logging is that incremental recording is not possible, only fixed interval recording can be performed.
Defines the total logging window time in seconds.
Defines the interval, in seconds, of the Tag recording
Table 54: Historical and real-time logging controls
3.4.2.1.1
Publish as Modbus TCP
This feature allows to access a Tag Value through Modbus/TCP. In that configuration, the eWON acts as a slave. Actually, there is no data map as in most PLC, instead of that you define Tag by Tag its Modbus TCP address.
3.4.2.1.1.1
Defining the Modbus TCP address
There are 4 types of Modbus variable, Contact (RO), Coil (RW), Input Register (RO), Holding register (RW). The type selected for the Tag that you want to publish will depend on its type:
Tag property
Boolean, RO
Boolean, RW
Analog, RO
Analog, RW
Modbus data type
Contact
Coil
Input register
Holding register
Table 55: the 4 Modbus variable types
Usually, the RO or RW property of a Tag is obvious. But in case of doubt, you can confirm the type by checking the View IO for the Tag:
• Remove the "Force Read Only" option in the Tag configuration (disabled by default).
• Check the View IO page, if the Tag has an update field, it means it is a RW Tag otherwise the Tag is RO.
• The address selected will be the address of the Modbus 16 bit register. The address range starts with register 1 (in the Modbus frame, eWON register 1 is transmitted as 0).
• Publish as float
The eWON supports accessing Tag values as float registers. The float is published with the IEEE representation and the value can be read on 2 consecutive registers, with the first register starting at the user defined address.
3.4.2.1.1.2
Modbus TCP rules
• When accessing Modbus registers or coils that are not mapped to an eWON register, the returned value is 0.
• Maximum number of registers readable in 1 request: 25
• Maximum number of coils readable in 1 request: 2000
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 86
General Reference Guide eWON Configuration
3.4.2.2
Tag "Alarm Action" edit window
Alarm action can be one of the following:
• Send an Email
• Send an SMS
• Send a file to an FTP server
• Send an SNMP Trap
The Alarm action window is accessed with the icon next to the Tag’s link.
Each of the four actions can be triggered with the following events:
• The alarm occurs (ALM) - low, lowlow, high or hihi (The alarm will also be triggered when changing the alarm level)
• Acknowledging (ACK)
• Return to normal level (RTN)
• End of Alarm (END)
Figure 73: Alarm notification setup
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 87
General Reference Guide eWON Configuration
3.4.2.2.1
Email on alarm configuration
The required configuration if an email must be sent in case of alarm. If an email must be sent through PPP, the system configuration (Main and
COM) must also be set up.
Alarm action Properties
Email upon
Short Message
Email To
Email CC
Email subject
Email attachment
Description
Checks the alarm states triggering an email (ALM, ACK, RTN, END).
In some cases it is useful to have the whole message sent in the subject. For example if you need to route email to SMS.
Usually this checkbox is disabled.
List of TO email address comma (, or ;) separated.
List of CC email address comma (, or ;) separated.
Will be the subject of the email (except if short message is selected).
Body text of the email.
This text can include Export Block Descriptor inline with text or as attachment.
Attachments to include in the Email must follow the syntax:
&[EXPORT_BLOC_DESCRIPTOR_1] &[EBD_2]…
There can be as many attachments as required.
EXPORT_BLOC_DESCRIPTOR syntax is described in chapter "Export Block Descriptor" on page 195
Example:
&[$dtRTGA_AN01$ftG] &[$dtEV$ftT]
Will export Real time data of GA_AN01 as a graph and the event log file as a text file.
Table 56: Email on alarm configuration controls
3.4.2.2.2
SMS on alarm configuration
Warning: Sending an SMS is only possible from an eWON that embeds a modem (c.f. Table 198 on page 209)
Alarm action Properties
SMS upon
SMS Destination
SMS Subject
Description
Checks the alarm states triggering an SMS (ALM, ACK, RTN, END).
A list of SMS_RECIPIENT;SMS_RECIPIENT;…
See below for the SMS_RECIPIENT syntax.
Will appear at the beginning of the SMS message.
Table 57: SMS on alarm configuration controls
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 88
General Reference Guide eWON Configuration
3.4.2.2.2.1
SMS_RECIPIENT: syntax
The SMS_DESTINATION defines the phone number of the SMS recipient.
In order to reach an SMS recipient, an SMS server must be called and the correct protocol must be used with that server. The server phone number depends on the GSM operator and the protocol used will be one of the 2 standard UCP or TAP protocol. A table with the SMS protocols and server phone numbers is available on http://support.ewon.biz/redirect/SMSProvider.htm
.
To introduce a pause in the number composition, use ’+’ in the number.
SPECIAL CASE FOR FRANCE USERS: as ucp and tap server is not available in France, the InfoZ protocol is available for eWONs embedding an analog modem. In that case the server phone number is 0. If a number has to be dialed to access the network it can be entered before the 0.
Example: if 9 must be dialed to leave PABX the syntax is 0407886633,ifz,90 if a pause is required to leave the PABX, the syntax will be 0407886633,ifz,9+0
See also www.infoz.fr
for details about the InfoZ service.
The syntax for SMS_RECIPIENT is:
• DDDD,TTT,MMM,PPP
Or
• DDDD,TTT,MMM
DDDD
TTT
MMM
PPP
Destination phone number
Protocol type, must be one of the 4 following values: ucp tap
It is possible to add a word datasize and parity specification. The generic syntax is ucpDP: with Datasize
D= 8 or 7 with Parity
P= n: none, o: odd, e: even
Examples: ucp7o ucp7e ucp7n ucp8n (default value)
It is possible to add a word datasize and parity specification. The generic syntax is tapDP with Datasize
D= 8 or 7 with Parity
P= n: none, o: odd, e: even
Examples: tap7o tap7e tap7n tap8n (default value) gsm ifz
Server phone number, see your GSM provider or for example: http://www.woodstone.nu/salive/PagerSettings.html
If the previous field is GSM or IFZ, the server must be set to
"0" - For SMSC see note ate the end of this §.
A password is sometimes required by the GSM provider.
40 char max
30 char max
Table 58: the SMS_recipient syntax
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 89
General Reference Guide eWON Configuration
Examples:
SMS on alarm "SMS Destination" syntax
0407886633,ucp,0475161622,proximus
0407886633,tap,0475161621
0407886633,gsm,0
0407886633,ifz,0
0495112233,gsm,0;0495445566,gsm,0
Explanations
ucp protocol requires the use of a password. In this case, the password is "proximus"
See in the above table for the word datasize and parity specification tap protocol does not require to enter a password.
See in the above table for the word datasize and parity specification
Syntax for sending an SMS from an eWON with a GSM/GPRS modem
Note: we advise you to exclusively use this syntax to send an SMS from an eWON that embeds a GSM modem (not tap or ucp protocols).
Syntax for sending an SMS from a PSTN modem in France
Send multiple SMS (note the ; between each SMS_Recipients)
Table 59: SMS destination syntax examples
All the above strings are valid. Concerning the three last examples in the list, the last "," is not mandatory as there is no password.
Important: Password is case sensitive.
When defining a phone number with a modem the "," is often used to insert a pause during the dialing operation. As the eWON uses the coma as a separator, the pause dial sign is replaced by a +.
For example the 0+0407886633 would dial a 0, then insert a 1 second pause, then dial 0407…
The gsm protocol attribute can be used in order to send the SMS directly through the GSM network, not using an SMS server. In this case, there is no server needed. This is valid only if the eWON embeds a GSM or GPRS modem.
BENELUX only: SEMASCRIPT
It is possible to send Semascript/ SemaDigit to a Semaphone inside of the Benelux area, by using the Belgacom server.
Example:
You want to send a semadigit to number 0498373101...
You must call the server at phone number 0458500001 (0+0458500001 if you must first dial a 0 and wait a pause)
Keep only the last 7 digits of the semaphone destination number, and use TAP protocol with "7e1":
sendsms "8373101,tap7e1,0458500001","0498373101"
if eWON is behind a PABX and 0 must be dialed first use:
sendsms "8373101,tap7e1,0+0458500001","0498373101"
FRANCE only: ALPHAPAGE
As for SEMASCRIPT, it is possible to send ALPHAPAGE messages to ALPHAPAGE pagers in France, by using the emessage server: the server is managed by a German firm called emessage, ( http://www.emessage.de/en/index.html
). As for the SEMASCRIPT users, the ALPHAPAGE users have chosen to keep on using a pager, with which the broadcasting coverage is better than with the GSM network (the users are sure to receive the message, that is not always the case with SMS).
The used protocol is TAP. The operating mode is the same as for SEMASCRIPT:
You want to send an ALPHAPAGE message to number 0612345678...
You must call the server at phone number 0836601212 (0+0836601212 if you must first dial a 0 and wait a pause)
Keep only the last 7 digits of the alphapage destination number, and use TAP protocol with "7e":
sendms "2345678,tap7e,0836601212"
if eWON is behind a PABX and 0 must be dialed first use:
sendms "2345678,tap7e,0+0836601212"
Note: How to specify the Message Service Center on a GSM modem?
To send out an SMS, the modem will send the message to the short message service center (SMSC) of the operator. The Service Center address (dial number) is normally automatically detected by the modem.
If needed, you can also force the Message Service Center address using the following syntax in the SMS Destination field:
"phone number,gsm,message service centre number"
Instead of "0407886633,gsm,0" it will be "0407886633,gsm,0032123456789" where 0032123456789 is the address (dial number) of the Service Center.
Warning: For the Service Center address do not use the + prefix syntax. eWON will replace the "+" sign by a ',' sign and thus will fail. So instead of using "+32123456789" use "0032123456789".
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 90
General Reference Guide eWON Configuration
3.4.2.2.2.2
Character encoding for SMS
Since firmware version 6.4 S1, eWON uses for all GSM modem types the character encoding GSM 03.38 to send out an SMS.
You will find more details and the character encoding matrix in the dedicated § "SMS Character set GSM 03.38" on page 223.
3.4.2.2.3
FTP on alarm configuration
Alarm action Properties
Put FTP upon
Destination file name
File content
Description
Checks the alarm states triggering the Put FTP (ALM, ACK, RTN, END)
Name of the file to create on the FTP server. The name can contain path specification.
The file content can be static or dynamic (see below)
Table 60: alarm action properties
3.4.2.2.3.1
File content:
If a standard text is put in the File Content field, the file built will receive that static text as content. If the File content has the following form, one or more file(s) will be written with a dynamic content:
[EXPORT_BLOC_DESCRIPTOR_1] [EBD_2]…
If the $fn field is used with multiple Export blocks, the "Destination File Name" property MUST be empty.
3.4.2.2.4
SNMP Trap on alarm configuration
If a trap has to be sent on an alarm, the checkbox corresponding to triggering an event has to be selected.
The edit box allows entering a specific text that will be displayed in the Trap event of the SNMP manager. The text string is limited to 256 chars.
All of the hosts that have been defined in the SNMP Setup menu (see chapter "SNMP Setup" on page 24) will receive the generated alarm Trap.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 91
General Reference Guide
3.5 Pages configuration
Page definitions are used in eWON for two purposes:
• Restrict user rights to specific directories in the user definable web site.
See also chapter "Users Setup" on page 8.
• Organize Tags in pages to ease viewing and restrict user access to specific Tags.
See also chapter "Users Setup" on page 8.
The Pages list setup that is accessed from the configuration navigation bar of the eWON looks as follows: eWON Configuration
Figure 74: Pages list setup
You may enter up to 10 user defined pages.
When Tags are defined in a specific page and the name of the page is modified, then the same Tags will belong to the renamed page. In other words, the Tag actually belongs to a page number, EXCEPT if the name of the page is changed to <nothing> (empty field). In that case, all the
Tags that belonged to the previous page will return in the default page. All the users who had access to that page only will have access to "All pages".
Any text can be entered for the page name, but if a page name is used for directory restriction, it must comply with the directory syntax.
3.6 IO servers setup
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 92
General Reference Guide eWON Configuration
3.7 Script Setup
The Script setup page that you can reach by clicking on the Script Setup link from the configuration navigation bar is used to create, modify or erase the scripts in the eWON and to test them.
Basic is the language that is used to write these scripts.
Further information about the structure and the syntax of this language is given in "eWON Programming Manual".
Figure 75: eWON script section page
The 3 available links in the script setup page are:
• The Edit Scripts link: to create, modify or delete the scripts
• The Script Control link: to test the scripts and enter one-shot commands
• The Run/Stop link: to run or stop the Basic scripts
3.7.1
The Edit script link
The 2 predefined scripts that are present in the eWON are:
• The Init section, which is executed once at the startup of the eWON.
• The Cyclic section, which is executed cyclically by the eWON.
This page is used to create, delete or edit script sections.
• The cycle time of the eWON BASIC is not pre-determined!
• This cycle depends on script itself.
• If well programmed, you can achieve the cycle time within one second.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 93
General Reference Guide eWON Configuration
• To edit a script section
Select the script that you want to display the code of from the Script Sections list, and then click on the Edit button, in order to display it in the edition window:
Figure 76: eWON Edit script section page
Click on the Update button to validate your modifications or on the Cancel button to quit without saving.
• To erase a script section:
Select the script section to delete and click on the Delete button.
• To create a new script section:
Click on the New Section button.
Enter the name of the script in the Script Name field and the code to execute in the blank edition area.
Figure 77: eWON new script section page
Click then on the Update button to validate your script, or on the Cancel button to quit without saving.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 94
General Reference Guide eWON Configuration
3.7.2
The Script control link
This page is used to monitor the result of the script execution and to execute some commands manually. You can use this page to easily debug your program.
Figure 78: eWON script control page
To display the result of the script execution, 2 actions must be performed:
• Start the script execution by clicking on the RUN link.
• Click on the Update Output button to update the display of the result screen.
It’s also possible to execute one-shot commands. Just fill in the blank field with the command to execute and then click on the Execute
Command button.
Validate the Script starts at eWON Boot checkbox to start the script automatically when the eWON boots. This change will be validated after you have clicked on the Update Autorun mode button.
3.7.3
The RUN/STOP link
This link is used to start or stop the script execution.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 95
General Reference Guide
3.8 Wizards
To help you quickly and easily configure some features, eWON provides you some wizards.
Use the logo to display the availables wizards on your eWON.
eWON Configuration
Figure 79: Wizards list
Wizard Description
Use this wizard to configure your eWON for Internet connection.
You can choose between Modem or WAN, encode your PIN code,
APN (for GPRS), choose if the connection will be permanent or
OnDemand, ...
Only available for eWON with modem.
Use this wizard to test your Internet connection.
Only available for eWON with modem.
Use this wizard to add your eWON to your Talk2M-Free or
Talk2M-Pro account.
Only available for eWON with VPN.
Use this wizard to configure your eWON to connect to an eFive (or Endian) VPN Server.
Only available for eWON with VPN.
Use this wizard to configure your eWON to connect to a MDEX account.
Only available for eWON with VPN.
Table 61: Wizards list
Depending on its type, the eWON will show you only the wizard corresponding to its hardware.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 96
General Reference Guide
4 Configuring the eWON by a file upload
eWON Configuration
It is possible to configure the eWON by uploading some files with an FTP client program.
If you need to configure the eWON, you will put the config.bin file or the two config.txt and comcfg.txt files on the root directory of the eWON.
You could also put the program.bas directly on the eWON. You can edit/modify the script Basic application in your favorite text editor, save as text file with the name program.bas and upload it in the eWON.
The files config.txt and comcfg.txt are interpreted by eWON. The eWON will use only the parameters that are known by it. In addition, you can send a config.txt file containing only the parameters that you want to modify.
For instance, if the Config.txt file only contains the following lines, only the eWON identification will be changed.
:System
Identification:New_Identification
The config.txt file contains three sections: System, TagList and UserList. A section must only be declared if at least one field of that group is present in the file. A field must always appear after its section declaration.
A section is declared on a separated line, preceded by a colon (See example above).
Each user and Tag appears on a separated line, with its field separated by a semicolon.
Example: the following config.txt file updates the eWON identification, defines a first user named "user1", a second user named "user2", and a
Tag named "tag1". Notice that for user1, the CBMode is not specified and takes the value 0 (Mandatory), while for user2, CBMode takes the value 1 (User Defined).
:System
Identification:eWON
Information:
:TagList
"Id";"Name";"Description";"ServerName";"Address";"tagvalue"
1;"tag1";"first Tag";"MEM";"tag1";"47"
:UserList
"Id";"FirstName";"LastName";"Login";"Password";"Information";"CBMode"
1;"Jacques";"Dupond";"user1";"thePassword";"first user";
2;"Albert";"Deux";"user2";"thePassword2";"second user";"1"
When creating a Tag or a user, any field that is not specified will take the default value. Be aware that when creating a user, the full rights are allowed on the Tags by default (v.o.a.c).
The fields found in the config.txt and comcfg.txt file can also be used with the GETSYS and SETSYS functions explained in "eWON Programming
Manual".
A table describing all the fields can be found in "eWON Programming Manual".
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 97
General Reference Guide IO Servers Configuration
5 The eWON IO Servers
5.1 Introduction
An IO Server is the interface between a changing value and the eWON monitoring engine. It is a kind of driver. Any variable from any data source must have a common representation for all IO Servers in order to define common interface in the eWON.
The data-source representation in the eWON uses 3 fields for the definition of a Tag:
• The IO Server Name
• The Topic name
• The Item Name
A Tag’s data-source will be uniquely identified with these 3 parameters:
IO Server name:
Topic Name:
Is a kind of driver name. For each IO Server there is a specific Topic Name and Item Name syntax.
Example: MODBUS, EWON, MEM
Is used to group items inside an IO Server, for example the memory IO Server uses the blank topic
("") and the retentive topic ("ret"). All Tags of the MEM IO Server defined in the "ret" topic will have their value saved and restored when the eWON boots.
All IO servers do not use a Topic Name. In that case the Topic Name field must be left empty.
Item Name:
The item name is a string of characters; its syntax is specific to each IO Server.
The Item Name describes the physical variable to monitor that uses the IO Server.
For example, the MODBUS IO Server needs to poll registers or coils from a slave, so it uses an item name representation to define the register type, register address and slave address. (Example "40001,5" => Where 4 means "read write register",
0001 is the register number and 5 is the slave Modbus address).
Table 62: Tags data-source parameters
5.2 IO servers setup
Some of the IO servers are configurable.
The IO setup window proposes a list of IO servers:
Figure 80: eWON IO servers scrolling list
Click on the Edit hyper link or select another IO server to display its edition window.
There are 3 possible cases regarding the IO server configuration:
• The IO server is not configurable
• The IO server has a dedicated configuration page (ex: MODBUS, UNITE, NETMPI, DF1, ...)
• The IO server uses the standard IO server configuration page.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 98
General Reference Guide IO Servers Configuration
5.2.1
IO Server Clear
To avoid the useless consumption of CPU and memory, the unused
IO Servers need to be "unloaded" from CPU tasks and the used memory need to be cleared.
For that purpose, the Clear function must be used.
Only set to disable the BaudRate of an IO Server make it idle, but this
IO Server is still in memory and use some CPU time (for nothing).
Click on the Clear link to reset the config of the displayed IO Server and unload it from memory.
Some IO Servers are not dynamically stoppable and need an eWON reboot to ensure the unload from memory. You will be warned with the following message.
5.2.2
IO Server Init
Click on the Init link to initialise an IOServer.
This initialisation will reset all IOServer counters (See "Status" on
page 185) and restart the tags validation process (See "Tags validation" on page 80).
5.2.3
Global Config
Figure 81: IOServer Global Config page
Item
Modbus TCP Port
Ethernet/IP Port
ISOTCP Port
FINS Port
Disable Tags in Error
Default TCP RX/TX Timeout
Description
Encode here the TCP Port number used for the ModbusTCP server protocol. Default is 502
Encode here the TCP Port used for the Ethernet/IP protocol (Allen Bradley). Default is 44818
Encode here the TCP Port number used for the ISOTCP protocol (Siemens). Default is 102
Encode here the TCP Port number used for the FINS protocol (Omron). Default is 9600
Activate the Tags Validation See "Tags validation" on page 80
Value in mSec for IOServer TCP timeout (need reboot to apply)
Note: To disable ports used for transparent gateway, set the corresponding port to 0 and reboot the eWON.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 99
General Reference Guide IO Servers Configuration
5.2.4
Standard IO server configuration page
When no dedicated configuration page is defined for configuring an IO server, the standard configuration page is used.
Figure 82: Standard IO server configuration page
As you can see in the above example, the standard configuration screen is a simple text edition area. Each parameter is entered on a separate line, the parameter value is separated from the parameter name by a colon ':' .
The generic format of a line is:
PARAM_NAME:PARAM_VALUE
Warning: Extra space must be removed.
When using this configuration, you must respect the correct syntax of each parameter and the values for each parameter.
The list of valid parameters and their corresponding valid values are listed in the corresponding IO server documentation (see following chapters).
Any error that would occur when the eWON applies the configuration that you have entered would be written to the event file. Please refer to
chapter “Files transfer” on page 180 to see how to get access to the events file.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 100
General Reference Guide IO Servers Configuration
5.3 Modbus IO server
5.3.1
Introduction
The MODBUS IO Server setup is the standard remote IO communication setup of the eWON. It is used to configure:
• The eWON as a Modbus RTU master.
• The eWON as a Modbus TCP slave and master.
The first feature (Modbus TCP slave) is specific to the MODBUS IO server; it is actually designed to provide access to eWON Tag values and, unlike all the other IO servers, for interfacing field values with the eWON.
The second feature (MODBUS Master) is the actual IO server feature that provides an interface to the field values as a common IO server.
The eWON MODBUS IO server will give access to values in equipments having a MODBUS interface.
The interface can be:
• RS485 / RS422 / RS232 – MODBUS RTU protocol will be used
• ETHERNET/PPP – MODBUS TCP protocol will be used.
The eWON can mix access to MODBUS RTU and MODBUS TCP, depending on the way the Tag address is defined.
5.3.2
Setup
5.3.2.1
Setup for eWON Server
Figure 83: Modbus TCP Server configuration
This page defines the eWON configuration when used as a Modbus TCP slave.
As described in the Tag configuration paragraph, each Tag can be published to Modbus TCP so that a Modbus TCP can read their values.
This setup screen defines the eWON address, and globally enables or disables the Modbus TCP slave feature.
eWON Server Properties eWON server enabled
Modbus TCP Unit address
Description
Globally enables or disables the Modbus TCP Server feature. If disabled, then any request from a Modbus TCP master will be rejected, even if Tags are published.
This feature is used by some gateway but can usually be left to 1 because Modbus TCP appears as a point to point connection.
Table 63: eWON server configuration - eWON as Modbus TCP slave
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 101
General Reference Guide
5.3.2.2
Setup for eWON IO server and Gateway - COM Setup
IO Servers Configuration
Figure 84: Modbus communications configuration
If more than one Serial port are available, you must choose on which COM the modbus request will be sent. This example of configuration shows an RS485 setup.
Field name
COM Port
Baud Rate
Parity
Stop Bit(s)
HW Mode
Reply Timeout
Description
Physical COM Port allocated to the Modbus IO Server. Drop down shows alternatives only if the relevant eWON has multiple serial ports (1).
Baud rate of the serial link (has to be the same than the target device). Default is Disabled.
Parity
Stop bit(s)
HW mode (half Duplex, Full Duplex HW Handshaking, Full Duplex NO Handshaking
Time (in msec) the eWON waits for an answer from the connected Modbus device.
The default value is 1000 msec
(1) For the eWON Flexy: The numbering of the serial COM ports starts with the serial port of the Base Unit (if available) and then continues with the upper port of the first Extension Module starting from the left. A maximum of 5 serial ports are supported.
Warning: If multiple IO servers are potentially using the same serial port, the unused IO server must be cleared or the baudrate must be set to Disabled. Example: if Modbus and UniTE IO servers are configured to the same port, at least one of them must have its baud rate set to
Disabled. If not the case, one of the IO servers will not be able to use the serial line and it will be disabled, with an error written in the event log.
5.3.2.3
Topic configuration
Figure 85: Modbus topics configuration
Three topics can be used for the IO Server. These topics are used to give a common property to a group of MODBUS Tag like:
• Enable/Disable
• Poll rate
• Slave address (Modbus RTU)
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 102
General Reference Guide IO Servers Configuration
• Unit address and TCP/IP address (Modbus TCP)
Modbus Server Properties
Topic enabled
Slave address
Poll rate
Description
Enables or disables polling of all the Tags in the topic.
The slave address is a global parameter for all the Tags of the topic. If the slave is connected with Modbus RTU, Slave address must be entered and the IP address must be blank. If the slave is Modbus TCP, its unit address and its IP address must be entered.
This defines the rate to which the Tag will be refreshed. In a complex application, we can imagine that some Tags must be refreshed every second – typically for digital input - and other every minute – typically: temperature-.
Table 64: Modbus topic configuration
Warning:
Any slave address that is defined in the Topic configuration overwrites the slave address configured per Tag.
If a Tag is defined with Tag Address: 40010,5 and the global address of the topic is 5 and 10.0.0.81, the Tag is entered as Modbus
RTU but it is polled as Modbus TCP. So, if you need to address slaves Tag by Tag, let the topic address configuration empty.
5.3.2.4
Advanced parameters
Figure 86: Modbus advanced parameters configuration
Extended parameters have been added to accommodate various special operating conditions. They are entered in the edit box at the bottom of the configuration page, conforming to the syntax below. Each parameter has a default value, so the advanced parameter edit box must only be
Parameter name
PreDelayFrom
PreDelayVal
ErrorRetry
SlowPollSkip
GatewayIPCTimeout
PostErrorDelay
MaxDeltaCoilX (X= A,B,C)
MaxDeltaRegX (X= A,B,C)
Description
Used in conjunction with the next parameter (PreDelayVal), starting at that slave address, the eWON will insert a delay when switching from one slave address to another. If the PreDelayVal feature is not used, then the value for PreDelayFrom must be set to 256 (default value).
Used to define the delay (in Msec) to be inserted before a request to a slave if a request was previously sent to another slave address (not between 2 requests to the same slave).
The PreDelayVal is placed only for slaves with an address higher than PreDelayFrom.
Defines the number of errors before the device enters in slow poll mode. (Minimum 1)
Defines the number of times the slave is skipped when in slow poll mode. This delay depends on the poll rate.
Maximum event lock while waiting for a response to a modbus gateway request from the modbus IO server (router) (in Msec – minimum 1000).
This delay (in Msec) is added each time a device responds with a framing error or a CRC error, in order to help the bus to perform its re synchronization (default value = 50).
Maximum number of Coils that can be grouped in a request (per topic) max=256
Maximum number of registers that can be grouped in a request (per topic) max=124
Table 65: extended IO server configuration controls
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 103
General Reference Guide IO Servers Configuration
5.3.2.4.1
Additional advanced parameters
• gwdestaddr
When the eWON is used as a Modbus gateway, it uses the UnitID from the ModbusTCP request to determine the Modbus RTU destination address.
It is possible to bypass this mechanism and force all the requests received by the eWON in ModbusTCP to be forwarded to a single ModbusRTU device (EXCEPT for requests with UnitID corresponding to the eWON's Modbus TCP Unit address (usually 100) when the eWON Server is enabled - see explanations about this precise point in the above configuration fields descriptions).
Every request is forwarded to the device with Slave address defined by the Modbus IO server advanced parameter called gwdestaddr.
If the advanced parameters textfield contains the following entry:
gwdestaddr:10
Then all therequests will be forwarded to the slave with address 10.
REMARK: the eWON will change the address before sending the request to the slave, then it will change it back when sending the response to the master (Modbus TCP master). So the gwdestaddr will never appear in any communication between the Master and the eWON.
• FastSrv
FastSrv is a mode which allows a supervisor to read in Modbus TCP more easily the Modbus tags published by the eWON. This mode completely changes the tag’s addressing, and when activated, the Modbus addresses are no more compatible.
You have just to enter "FastSrv:1" in the Advanced Parameters text area to activate it. When done, the Modbus tags can be read as follows:
X
X+2048
X+4096
X+6144
Integer (with scale factors and offset defined)
Float (X+2048: 1
ST
float, X+2048+2: 2 nd
float, etc.)
Alarm status
Alarm type
Notes:
• If the tag is binary read, its value is worth 0 if tag==0, and 1 if tag <>0
• Writing 0 in AlarmStatus acknowledges the alarm (will be logged by eWON as acknowledged by administrator)
• It is not possible to write a coil in the float area (coil address range: X+2048 to X+4094)
• It is not possible to address more than 1024 registers in float.
Click on the Update Config button to validate your inputs or use the Cancel button to discard changes
• TcpPort
Use the 'TcpPort' parameter to change the default 502 port used when the eWON is ModbusTCP CLIENT.
If not specified the 502 default value is used.
This Port value is used for all the ModbusTCP client connections.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 104
General Reference Guide IO Servers Configuration
5.3.3
Tag name convention
IO Server Name
MODBUS
Topic Name
A or B or C
Item Name
ValueName,SlaveAddress
ValueName,SlaveAddress,IPAddress
ValueName
IO Server configuration
The PLC Address is defined Tag by Tag on serial link (RTU Master)
The PLC Address is defined Tag by Tag on TCP link
The Topic PLC address is used
5.3.3.1
ValueName
The Modbus IO Server Tags can be classified following ranges of values. Two types of ranges are used. The two following tables describe the different ranges of value, for each of the two standards.
• First standard:
Modbus Type
Coil
Contact
Input Register
Holding Register
Output Coil*
Output Registers*
IO Type
Digital Output
Digital Input
Analog Input
Analog Output
Digital Output
Analog Output
Access
R/W
R
R
R/W
W
W
Table 66: Modbus IO server Tag name convention: first standard
• Second standard:
Register address
1 Æ 9999
10001 Æ 19999
30001 Æ 39999
40001 Æ 49999
50001 Æ 59999
60001 Æ 69999
Modbus Type
Coil
Contact
Input Register
Holding Register
Output Coil*
Output Registers*
IO Type
Digital Output
Digital Input
Analog Input
Analog Output
Digital Output
Analog Output
Access
R/W
R
R
R/W
W
W
Table 67: Modbus IO server Tag name convention: second standard
Register address
+1 Æ +65535
+100001 Æ +165535
+300001 Æ +365535
+400001 Æ +465535
+500001 Æ +565535
+600001 Æ +665535
The second standard allows more than 9999 values in each range. Notice the "+" sign before the register value.
* The two last ranges are used with non-standard equipments that do not allow the reading of some of their values. In this case, specifying the address in the "write only" ranges informs the eWON not to read the values after setting them, which is normally done in the other cases. If those registers are read, the returned value will always be 0.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 105
General Reference Guide IO Servers Configuration
After the numerical value, the characters F, L, I, D or W can be used to specify how to read the value. The following table describes the different character meaning.
Character
F
H
L
M
D
E
W
I
Description
Reads 1 register considered as 16 bits unsigned integer (DEFAULT IF NOT SPECIFIED)
Reads 1 register considered as 16 bits signed integer
Reads 2 regs R1, R2 as a DWORD R1 is Less significant, R2 is most significant (32 bits, unsigned) (*)
Reads 2 regs R1, R2 as a DWORD R2 is Less significant, R1 is most significant (32 bits, unsigned) (*)
Reads 2 regs R1, R2 as a LONG R1 is Less significant, R2 is most significant (32 bits, signed) (*)
Reads 2 regs R1, R2 as a LONG R2 is Less significant, R1 is most significant (32 bits, signed) (*)
Reads 2 regs R1, R2 as a FLOAT R1 is Less significant, R2 is most significant (32 bits, signed)
Reads 2 regs R1, R2 as a FLOAT R2 is Less significant, R1 is most significant (32 bits, signed)
Automatic
Tag type
DWord
Integer
DWord
DWord
Integer
Integer
Float
Float
Table 68: the characters used to specify how to read the value
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
When reading a 32 bits value, two consecutive registers or coils are read and combined e.g. 40001L,11 to access in Long representation the reg
1 on the slave 11.
examples: address
40001,10
1,11
+320234,12 meaning
access the Holding Register at address 1 on the UnitID 10 access the Coil at address 1 on the UnitID 11 access the Input Register at address 20234 on the UnitID 12
40001,100,10.0.0.53
access the Hoding Register at address 1 on the UnitID 100 at IP address 10.0.0.53
40010L,12
access the LONG Holding Register at address 10 (and 11) on the UnitID 12
40008F,15
access the FLOAT Holding Register at address 8 (and 9) on the UnitID 15
Table 69: Modbus address examples
STATUS TAG:
The STATUS Tag is a special Tag that returns information about the current state of the communication for a given device. As for other Tags, the status Tag ItemName is composed of:
Status,Address
If the address is omitted, the Topic address will be used (e.g.: status,11) points to the status of the slave 11
You can define a status Tag for each address used.
If you use the status MODBUS address, the Tag must be configured as analog:
Tag value
0
1
2
Meaning
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 70: MODBUS status values
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 106
General Reference Guide IO Servers Configuration
5.3.3.2
Slave Address
This is the address of the slave device that you want to access.
It is a number from 0 to 255.
Example:
30001,11
Polls a RTU device at address 11.
5.3.3.3
IP Address
This is the IP address of the device on an Ethernet network. It is composed of 4 numbers separated by a dot.
Example:
30001,11,10.0.0.50
Polls a device configured with IP address 10.0.0.50 and with Modbus slave address 11.
5.3.3.4
Device specific information
Warning for new users of WAGO modules:
Keep in mind that coil read and write don’t use the same address (offset of 0x200); please consult the Wago™ documentation.
Example:
If you use Wago™ systems with two digital inputs and two digital outputs, inputs have addresses 1 and 2, and outputs have the same. The only way to distinguish them it’s the read-only access or R/W access.
Tags: station 11
Tag
MB_DigIn1
MB_DigIn2
MB_DigOut1
MB_DigOut1Read
MB_DigOut2
MB_DigOut2Read
Modbus address
10001,11
10002,11
00001,11
10513,11
00002,11
10514,11
Comment
Digital input module 1 -- read-only
Digital input module 2 -- read-only
Digital output module 1 for writing - Encode all leading zeroes!
Digital output module 1 for reading only
Digital output module 2 for writing
Encode all leading zeroes!
Digital output module 2 for reading only
Table 71: Wago™ modules - addresses examples
In View I/O page, you can change the value of MB_DigOut1 with the update link (set to 1), and if you do that, you view that the value read is always 0.
Why?
Because the eWON reads the value at the WAGO address 1 (thus, DigIn1)! If you want to read the state of the DigOut1, you must read it at
WAGO address 513!
The same remark is applied for analog Modbus registers. It’s the documented behavior of Wago™-Modbus modules; keep it in mind.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 107
General Reference Guide IO Servers Configuration
5.4 NETMPI IO Server
5.4.1
Introduction
NETMPI IO server is used to communicate with SIEMENS PLC. The eWON will connect to the PLC’s MPI interface by means of the eLINK adapter.
The eLINK adapter is an interface with an MPI interface on one side and an Ethernet TCP/IP interface on the other side.
The eLINK interface will be configured with an IP that the eWON will use to poll data. In addition to the IP address, the eWON will need the MPI address of the PLC on the MPI bus.
Using that eLINK interface, it is possible to poll different types of item in the PLC. These items types are described below.
5.4.2
Setup
Figure 87: NETMPI configuration window
As for the Modbus and Unite protocols, it is possible to define topics, so that a single configuration can be applied to several Tags.
5.4.3
Tag name convention
IO Server Name
Topic Name
Item Name
B
C
NETMPI
A
ValueName,RemoteStationAddress,eLinkIpAddress
ValueName
IO Server configuration
PLC Address is defined Tag by Tag
Topic PLC Address is used
Table 72: NETMPI - IO server configuration
The Item Name can contain the PLC address where the value is polled, or not. If address is also specified at topic level, the address specified at
Tag level will be ignored.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 108
General Reference Guide IO Servers Configuration
5.4.3.1
ValueName
Syntax
DBxBy
DBxWy
DBxFy
DBxDy
MxB
MxW
MxF
MxD
Tx
Cx
Description
Data block x Byte offset y (0-255)
Data block x Word offset y (0 - 65535)
Data block x Float offset y (+-3.4e38)
Data block x DWord offset y (-2147483648->2147483647) (*)
Memento x as byte
Memento x as word
Memento x as real
Memento x as double (*)
Timer x (0-65535)
Counter x (0-65535)
Automatic
Tag type
DWord
DWord
Float
Integer
DWord
DWord
Float
Integer
DWord
DWord
Table 73: value names for NETMPI addresses
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
• Bit access modifier:
In any of the above items, it is possible to access a single bit (except for float items).
#x must be appended to the Value Name. (Bit index goes from 0..31)
The syntax can be used for reading bits and for writing them as well.
Example:
DB1W13#3 represents bit 3 of W13 in DB 1
REM:
Bit index range depends on a referenced item (for W, bit index maximum value is 15)
• Status register:
The STATUS Tag is a special Tag that returns information about the current state of the communication for a given device. As for other Tags, the status Tag ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each PLC used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 74: Tag Status meaning
5.4.3.2
Device Address
The device address is either appended to the ValueName in the Item Name definition, or entered in the Topic global address fields.
The device address is composed of: RemoteStationAddress,eLinkIpAddress:
• RemoteStationAddress: is the PLC’s MPI address
• eLinkIpAddress: is the eLINK IP address.
Important:
If the PLC address is defined at the Topic level, it can be omitted in the Tag definition. In that case the Tag name will only contain the "ValueName".
If the PLC address is specified at the Topic level, it will replace any address defined Tag by Tag.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 109
General Reference Guide IO Servers Configuration
5.5 UNITE IO Server
5.5.1
Introduction
The eWON RS485 link can be configured as an UNITELWAY SLAVE INTERFACE. When the BaudRate in the UNITE IO Server is set to a value different than "Disabled", the Unitelway slave module in the eWON will be enabled.
This Unitelway slave provides 2 features:
• Poll items in a Unitelway capable device.
The device can be the Unitelway master itself or a device addressable through the Unitelway master on the XWay network.
• Forward XIP requests from TCP/IP XIP to Unitelway bus and thus, act as a gateway between XIP and Unitelway.
Using that feature, it is possible to access a PLC connected to the eWON’s Unitelway link by connecting PL7PRO using the XIP driver started with the eWON IP address as destination.
5.5.2
Setup
5.5.2.1
Communication Setup
Figure 88: XWAY-UNITELWAY configuration
If more than one Serial port are available, you must choose on which COM the Unitelway request will be sent.
Field name
COM Port
Baud Rate
Parity
Stop Bit(s)
Master Response Timeout
Rx message timeout (MSEC)
Tx message timeout (MSEC)
Description
Physical COM Port allocated to the Unite IO Server. Drop down shows alternatives only if the relevant eWON has multiple serial ports (1).
Baud rate of the serial link (has to be the same than the target device). Default is 9600..
The parity to apply: none / odd / even. This field is set by default to Odd, as in the main cases in a typical UniTE topology. However, the eWON allows you to define a different parity type (Even or
None), in case this is needful to comply with your industrial network installations.
Number of stop bits
Maximum time the eWON will wait for a valid message from the Unitelway master. This value can be critical for a correct operation, depending on the responsiveness of the master. A value of 1000 should be selected to guarantee a correct operation.
Maximum time between a request is posted and the response is received
Maximum time for a request to be sent
Table 75: XWAY communication setup controls
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 110
General Reference Guide IO Servers Configuration
Force UnitelWay V2
ADO
Xway Network Station
If checked, the eWON will initiate a communication in V2 with the devices. When used with a TSX
PLC, this check box can be left unchecked.
Link address base. The eWON will respond to AD0 and AD0+1 on the Unitelway link.
The eWON will act as an Unitelway slave, it will respond to 2 consecutive link addresses AD0 and
AD0+1, doing this improves the throughput of data across the eWON when acting as a gateway.
Address of the eWON on the XWAY network.
When acting as an XIP to Unitelway gateway, the eWON will only respond the XWay network station defined here. Any XIP frame addressed to another network station will be ignored.
Table 75: XWAY communication setup controls
(1) For the eWON Flexy: The numbering of the serial COM ports starts with the serial port of the Base Unit (if available) and then continues with the upper port of the first Extension Module starting from the left. A maximum of 5 serial ports are supported.
Warning: When there are multiple IO servers potentially using the serial line, the unused IO servers must be cleared or the baudrate must be set to Disabled. Example: if Modbus and UniTE IO servers are available, at least one of them must have its baudrate configured to Disabled.
If not, one of the IO servers will not be able to use the serial line and it will be disabled, with an error written in the event log.
5.5.2.2
Topic configuration
Figure 89: XWAY-UNITELWAY topics configuration
Three topics can be used for the IO Server. These topics are used to give a common property to a group of UNITE Tags such as:
• Enable/Disable
• Poll rate
• Global Slave address
Topic configuration item
Topic enabled
Global Slave Address
Poll rate
Description
Enables or disables polling of all the Tags in the topic.
This Slave address is a global parameter for all the Tags of the topic. See below for the Device
Address syntax. If an address is specified here, it will replace (overload) the address defined Tag by
Tag.
Defines the refresh rate of the Tag name. In a complex application, we can imagine that some Tag name must be refreshed every second – typically for digital input - and other every minute – typically: temperature-.
Table 76: UNITE - topics configuration
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 111
General Reference Guide IO Servers Configuration
5.5.3
Tag name convention
IO Server Name
Topic Name
Item Name
IO Server configuration
B
C
UNITE
A
ValueName,Network,Station,Gate,Module,Channel
ValueName,Network,Station,Gate
ValueName
PLC Address is defined Tag by Tag (and the gate requires a
5 level addressing)
PLC Address is defined Tag by Tag
Topic PLC Address is used
Table 77: UNITE - IO server configuration
The Item Name can contain the PLC address where the value is polled, or not. If the address is also specified at topic level, the address specified at Tag level will be ignored. If the Topic address is not defined either, then address 0,254,0 will be used.
5.5.3.1
Value Name
Value name follows the syntax below:
Syntax
MWxW
MWxI
MWxD
MWxF
MWxL
SWxW
SWxI
SWxD
SWxL
Mx
Sx
Description
Internal data word 16 bits (unsigned)
Internal data word 16 bits (signed)
Internal data word 32 bits as DWORD (unsigned) (*)
Internal data word 32 bits as IEEE float
Internal data word 32 bits as LONG (signed) (*)
System data word 16 bits (unsigned)
System data word 16 bits (signed)
System data word 32 bits as DWORD (unsigned) (*)
System data word 32 bits as LONG (signed) (*)
Internal data bit
System data bit
Table 78: value names for UNITE addresses
Automatic
Tag type
DWord
Integer
DWord
Float
Integer
DWord
Integer
DWord
Integer
DWord
DWord
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
Notes:
SW type cannot be formatted as float
The eWON allows you to optimize the requests in case you need to read a lot of Tags that have been created on the UniTelWay device. Imagine you have 100 Tags to read, the eWON will group the Tags within a predefined limit in order to make the less as reading operations as possible. The number of Tags that can be read depends of the types of words or bits that have to be read:
SW and MW types: by groups of 50
S and M types: by groups of 200
It is possible to read one bit from a word. The syntax to add is as follows:
#0 to #31
That means that if you want to read the fifth bit from an internal data word 16 bits unsigned that you address MW0, you have to add
"#4" at the end of the address: MW0#4.
The type of words for which this syntax can be applied are:
MWxW, MWxI, MWxD, MWxL, SWxW, SWxI, SWxD and SWxL (please report to the table above).
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 112
General Reference Guide IO Servers Configuration
examples: address
MW10 or MW10W
MW10D
MW10W#5
SW2 or SW2W point to
the Internal data Word (16bits) at address 10 the Internal data Word (as DWord 32bits) at address 10 the bit 5 (the sixth) from the Word at address 10 the System data Word (16bits) at address 2
Table 79: UNITE address examples
• Status register:
The STATUS Tag is a special Tag that returns information about the current state of the communication for a given device. As for other Tags, the status Tag ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each PLC used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 80: Tag Status meaning
5.5.3.2
The device address syntax
The Device Address is used in the topic definition or in the Tag definition. If used in the Tag definition, it will be separated from the value name by a coma (’,’)
• Network,Station,Gate
example: 0,254,0 to access the UnitelWay device directly connected on the eWON or
• Network,Station,Gate,Module,Channel
The second case applies to addresses with 5 levels:
• Network: 0..127
• Station: 0..63
• Gate:
• Module:
• Channel:
Module and channel can be omitted if not required.
Note: If the address is not specified, 0,254,0 will be used.
Important: If an address is specified in a Topic definition it will replace any address defined Tag by Tag.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 113
General Reference Guide IO Servers Configuration
5.6 DF1 IO Server
5.6.1
Introduction
The eWON serial link can be configured as a DF1 INTERFACE. When the Baud Rate in the DF1 IO Server is set to a value different than
"Disabled", the DF1 module in the eWON will be enabled.
This DF1 module provides 3 features:
• Poll items in SLC50x and PLC5 controllers using PCCC requests.
• Forward PCCC requests from EIP (TCP/IP) to DF1 bus and thus, acts as an adapter between EIP and DF1.
Thanks to that feature, it is possible to access a PLC connected to the eWON’s DF1 link by connecting RSLogix 500 using RSLinx TCP driver started with the eWON IP address as destination.
• Poll DH+ device using ControlLogix gateway
The DF1 IO Server must be configured in Full Duplex mode (eWON serial link must be configured in RS232 mode, with dipswitch).
note: Please check in the “Rockwell compatibility matrix” on page 236 if your device is supported.
5.6.2
Setup
5.6.2.1
Communication Setup
Figure 90: DF1 communications setup
If more than one Serial port are available, you must choose which COM the DF1 request will be sent to.
The following parameters can be modified:
Field name
COM Port
Baud Rate
Parity
Stop Bit(s)
Frame Error Detection
HW mode
Master Response Timeout
Description
Physical COM Port allocated to the DF1 IO Server.
Note: In the example above, the port selection drop down is not displayed because the eWON has only one single serial port. For multiple serial ports see remark (1).
Select the Baudrate from 1200 to 38400 Bauds
The parity to apply: none / odd / even
Number of stop bits
Cyclic Redundancy Check (CRC) or Block Check Character (BCC)
Full Duplex no handshaking or Half duplex
Maximum time the eWON will wait for a valid message from the DF1 master. This value can be critical for a correct operation, depending on the responsiveness of the master. A value of
1000 should be selected to guarantee correct operations
Table 81: DF1 communication setup controls
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 114
General Reference Guide IO Servers Configuration
Rx message timeout (MSEC)
Tx message timeout (MSEC) eWON DF1 address
Destination DF1 address
Bridge EIP connection
Maximum time between a request is posted and the response is received
Maximum time for a request to be sent
The eWON’s device address on the DF1 link
When th eWON acts as a DF1 slave, it will respond to 2 consecutive link addresses; doing this improves the throughput of data across the eWON when acting as a gateway. (eWON
DF1 address and eWON DF1 address +1)
Device Address of Destination on DF1 link when EIP is used
When bridging is configured, EIP connections requests are forwarded to the PLC on the DF1 interface (mandatory for Logix family). This is the default configuration.
When not configured, connection requests are cancelled by the eWON (must be disabled for
SLC family).
Table 81: DF1 communication setup controls
(1) For the eWON Flexy: The numbering of the serial COM ports starts with the serial port of the Base Unit (if available) and then continues with the upper port of the first Extension Module starting from the left. A maximum of 5 serial ports are supported.
Warning: When there are multiple IO servers potentially using the serial line, the unused IO servers must be cleared or the baudrate must be set to Disabled. Example: if Modbus and DF1 servers are available, at least one of them must have its baudrate configured to Disabled. If not, one of the IO servers will not be able to use the serial line and it will be disabled, with an error written in the event log.
5.6.2.2
Topic configuration
Figure 91: DF1 topics configuration
Three topics can be used for the IO Server. These topics are used to give a common property to a group of DF1 Tags like:
• Enable/Disable
• Poll rate
• Destination Device Type and Address
Topic configuration item
Topic enabled
Destination Device Type and
Address
Poll rate
Description
Enables or disables the polling of all the Tags in the topic
The Destination Device Type and Address is a global parameter for all the Tags of the topic.
See below for the Device Address syntax. If an address is specified here, it will replace
(overload) the address defined Tag by Tag
Defines the refresh rate of the Tag name. In a complex application, we can imagine that some
Tag name must be refreshed every second – typically for digital input - and other every minute
– typically: temperature-
Table 82: DF1 topics configuration setup
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 115
General Reference Guide IO Servers Configuration
5.6.2.2.1
DF1 : serial link
The Destination Device Type and address are :
• SLC500-x (where x is the address of your SLC500 or Micrologix Device, range 0..254)
• PLC5-x (where x is the address of your PLC5 Device, range 0..254)
i.e.: Topic A Destination = SLC500-1
Topic B Destination = PLC5-6
For accessing a Micrologix, use the SLC500 syntax
Topic C Destination = SLC500-3 (accessing the Micrologix at address 3)
5.6.2.2.2
DF1 : Ethernet routing
Thanks to the ABLogix IOServer, the eWON is now able to poll data on SLC500/PLC5 devices by its Ethernet link. Even SLC500 connected behind your ControlLogix Network becomes available for polling.
With this use of DF1 IOServer, the Serial config can be left unconfigured (baudrate=disabled), only one Topic enabled is required.
You need to use a similar syntax than in ABLogix IOServer.
[DeviceType-] IP Address [, Port, Link]
• DeviceType = type of PLC ( SLC500 or PLC5 )
•
IP Address
= address on your Ethernet network (i.e.: 10.0.0.50)
•
Port
= value from 1 to 3 representing: 1 = Backplane, 2 = Channel A, 3 = Channel B
•
Link
could be:
¤ Slot: representing the Slot on the Backplane (0=CPU)
¤ Node ID: value from 0 to 99 (for ControlNet)
¤ IP address
To reach a SLC500 with Ethernet address 10.0.0.60:
Topic A Destination = 10.0.0.60 or
SLC500-10.0.0.60
To reach a PLC5 with Ethernet address 10.0.0.65:
Topic A Destination =
PLC5-10.0.0.65
To reach a SLC500 connected behind a ControlLogix :
Topic A Destination =
10.0.0.80,1,3,2,45 or SLC500-10.0.0.80,1,3,2,45
•
10.0.0.80
= IP address of the ControlLogix
•
1
= BackPlane
•
3
= Slot 3 (COM card in ControlNet)
•
2
= Channel A (of the Card present in Slot 3)
•
45
= NodeID of the SLC500 (in the ControlNet network)
To reach a PLC5 connected behind a ControlLogix :
Topic A Destination =
PLC5-10.0.0.90,1,3,2,44
•
10.0.0.90
= IP address of the ControlLogix
•
1
= BackPlane
•
3
= Slot 3 (COM card)
•
2
= Channel A (of the Card present in Slot 3)
•
44
= NodeID of the PLC5 (in the COM network)
5.6.2.2.3
DH+ polling using ControlLogix gateway
This feature allows the eWON to poll PLC Tags located on a DH+ network, behind a controllogix equipped with one or more DHRIO cards.
Polling is done using eWON EIP protocol.
The DF1 IO server is used to access the "SLC500" PLC family. The ABLOGIX IO server is used to access the "LOGIX" PLC family.
The syntax [Device Type-] IP address [,Port,Link] is still applicable but in this particular case: the [,Port,Link] part becomes mandatory
The DH+ channel used to reached the "SLC500" PLC must be specified using the "A" or "B" character.
Example: To reach a SLC500 with DH+ node Id 5, using channel A of a DHRIO card at slot 9 of a controllogix at IP address 10.0.30.21.
Topic A Destination = SLC500
-
10.0.30.21,1,9,A,5
•
10.0.30.21
= IP address of the ControlLogix
•
1
= BackPlane
•
9
= Slot 9 (COM card)
•
A
= Channel A (of the Card present in Slot 9)
•
5
= NodeID of the SLC500 (in the COM network)
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 116
General Reference Guide IO Servers Configuration
5.6.3
Tag name convention
IO Server Name
Topic Name
Item Name
IO Server configuration
B
C
DF1
A
ValueName, DeviceType-DeviceAddress
ValueName
Device Type and Address are defined Tag by Tag
Only device Type SLC500 is supported
Device Address is a number between 0..254
Topic PLC Address is used
Table 83: DF1 IO server configuration
The Item Name can contain the PLC address where the value is polled, or not. If the address is also specified at the topic level, the address specified at Tag level will be ignored.
5.6.3.1
Value Name
5.6.3.1.1
General Description
The general format of value names for data from SLC-500 controllers matches the naming convention used by the programming software. The format is shown below (The parts of the name shown between square brackets are optional).
General Value Name Format: X[file]:element [.field][/bit]
X: Identifies the file type. The below table summarizes the valid file types, default file number for each type and the fields allowed.
X
O
I
S
B
T
C
R
N
F
A
File Type
Output
Input
Status
Binary
Timer
Counter
Control
Integer
Floating
ASCII
Default file
Number
0
1
4
5
2
3
6
7
8 none
Fields
.PRE, .ACC, .EN, .TT, .DN
.PRE, .ACC, .CU, .CD, .DN, .OV, .UN, .UA
.LEN, .POS, .EN, .DN, .ER, .UL, .IN, .FD
Table 84: value names for DF1 addresses
• File: File number must be 0-255 decimal
• Element: Element number within the file
• Field: Valid only for Counter, Timer and Control files
• /bit: Valid for all types except Floating
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
Automatic
Tag type
DWord
DWord
DWord
DWord
DWord
DWord
DWord
DWord
Float
DWord
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 117
General Reference Guide IO Servers Configuration
5.6.3.1.2
Output File Items
Output File Item Format: O[n]:e.s[/b]
• "n" represents the file number and is optional. Value is always zero
• "e" indicates the element number in the file (0..30)
• "s" indicates the sub-element number (0..255)
• "b" specifies the bit (0..15) decimal
Note for the Micrologix Series:
The syntax for Output File Items for the Micrologix Series is slightly different:
Basically, it drops 1 digit to show O:1 instead of O:0.1
Actually the eWON reads consecutive words.
Example for the Micrologix 1400
PLC
Adressing
O:0.2
O:1.0
eWON
Adressing
O:2
O.6
This expample shows that when stepping to another output card, the incrementation continues in the eWON (from O:5 to O:6) while in the PLC itself it increments the first digit (from O:0.5 to O:1.0).
5.6.3.1.3
Input File Items
Input File Item Format: I[n]:e.s[/b]
• "n" represents the file number and is optional. Value is always one
• "e: indicates the element number in the file (0..30)
• "s" indicates the sub-element number (0..255)
• "b" specifies the bit (0..15) decimal
•
Note for the Micrologix Series:
The syntax for Input File Items for the Micrologix Series is slightly different:
Basically, it drops 1 digit to show O:1 instead of O:0.1
Actually the eWON reads consecutive words.
Example for the Micrologix 1400
PLC
Adressing
I:0.7
I:1.0
eWON
Adressing
I:7
I.8
This expample shows that when stepping to another input card, the incrementation continues in the eWON (from I:7 to I:8) while in the PLC itself it increments the first digit (from I:0.7 to I:1.0).
•
5.6.3.1.4
Status File Items
Status File Item Format: S[n]:e[/b]
• "n" represents the file number and is optional. If not specified, it is assumed to be 2
• "e" indicates the element number in the file (0..255)
• "b" specifies the bit (0..15) decimal
5.6.3.1.5
Binary File Items
Binary File Item Format: B[n]:e/b
• "n" represents the file number and is optional. If not specified, it is assumed to be 3, otherwise must be between 3 and 255 decimal
• "e" indicates the element number in the file (0..255)
• "b" specifies the bit (0..15) decimal
Note:
The format B[n]/b is not supported.
5.6.3.1.6
Timer File Items
• Timer File Item Format: T[n]: e [.f] [/b]
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 118
General Reference Guide IO Servers Configuration
• "n" represents the file number and is optional. If not specified, it is assumed to be 4, otherwise must be between 4 and 255 decimal
• "e" indicates the element number (3 words per element) in the file (0..255)
• "f" identifies one of the valid values for timer fields specified in the table above. If omitted it is assumed to be the word containing the status bits
• "b" specifies the bit (0..15) decimal
5.6.3.1.7
Counter File Items
Counter File Item Format: C[n]: e [.f] [/b]
• "n" represents the file number and is optional. If not specified, it is assumed to be 5, otherwise must be between 5 and 255 decimal
• "e" indicates the element number (3 words per element) in the file (0..255)
• "f" identifies one of the valid values for counter fields specified in the table above. If omitted it is assumed to be the word containing the status bits
• "b" specifies the bit (0..15) decimal
5.6.3.1.8
Control File Items
Counter File Item Format: C[n]: e [.f] [/b]
• "n" represents the file number and is optional. If not specified, it is assumed to be 6, otherwise must be between 6 and 255 decimal
• "e" indicates the element number (3 words per element) in the file (0..255)
• "f" identifies one of the valid values for counter fields specified in the table above. If omitted it is assumed to be the word containing the status bits
• "b" specifies the bit (0..15) decimal
5.6.3.1.9
Integer File Items
Integer File Item Format: N[n]:e[/b]
• "n" represents the file number and is optional. If not specified, it is assumed to be 7, otherwise must be between 7 and 255 decimal
• "e" indicates the element number in the file (0..255)
• "b" specifies the bit (0..15) decimal
5.6.3.1.10
Floating File Items
Floating File Item Format: F[n]:e
• "n" represents the file number and is optional. If not specified, it is assumed to be 8, otherwise must be between 8 and 255 decimal
• "e" indicates the element number in the file (0..255)
5.6.3.1.11
ASCII File Items
ASCII File Item Format: An:e[/b]
• "n" represents the file number and is not optional
• "e" indicates the element number in the file (0...255)
• "b" specifies the bit (0..15) decimal
5.6.3.1.12
Status register
The STATUS Tag is a special Tag that returns information about the current state of the communication for a given device. As for other Tags, the status Tag ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each PLC used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 85: Tag Status meaning
5.6.3.2
Destination Device Type and Address
The Device Address is used in the topic definition or in the Tag definition. If used in the Tag definition, it will be separated from the value name by a coma (’,’).
• Format:
DeviceType-DeviceAddress
The Destination Device Type and address are :
• SLC500-x (where x is the address of your SLC500 or Micrologix Device, range 0..254)
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 119
General Reference Guide i.e.:
• PLC5-x (where x is the address of your PLC5 Device, range 0..254)
Topic A Destination = SLC500-1
Topic B Destination = PLC5-6
For accessing a Micrologix, use the SLC500 syntax
Topic C Destination = SLC500-3 (accessing the Micrologix at address 3)
• Format:
[DeviceType-] IP address [,Port,Link]
example: 10.0.0.80 to access a SLC500 (or a Micrologix)
See "DF1 : Ethernet routing" on page 116
IO Servers Configuration
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 120
General Reference Guide IO Servers Configuration
5.7 FINS IO Server
5.7.1
Introduction
The FINS IO Server includes the configuration of:
• The eWON as a FINS Hostlink client (master) to give access on values in CSCJ series OMRON equipments reachable using eWON serial port(s).
• The eWON as a FINS TCP/UDP client (master) to give access on values in CSCJ OMRON equipments reachable using eWON
Ethernet interface.
• The eWON as a FINS TCP/UDP server acting as a gateway between the Ethernet/PPP interface and the serial interface (used to connect remotely programming/monitoring software to OMRON FINS supporting equipments reachable using eWON serial ports).
The FINS IO Server is designed to provide simultaneous access to OMRON equipments on its serial interface and Ethernet interface. The correct protocol will depend on the topic that the Tag belongs to. UDP and TCP protocols can be mixed as well on the Ethernet interface.
When the BaudRate in the FINS IO Server is set to a value different than "Disabled", the serial Hostlink Client will be enabled.
The FINS IO Server can be configured in 3 modes:
• Full Duplex mode (eWON serial link must be configured in RS232 mode) without HW handshaking
• Full Duplex mode with HW handshaking
• Half Duplex slave mode (RS485 mode)
5.7.2
Setup
5.7.2.1
Communication Setup
Figure 92: FINS IO server COM setup
The following parameters can be modified:
Field name
COM Port
Baud Rate
Parity
Data Bits
Stop Bit(s)
HW mode
ReplyTimeout
Ethernet FINS network
Description
Physical COM Port allocated to the FINS IO Server.
Note: The port selection drop down is not displayed if the eWON has only one single serial port. For multiple serial ports see remark (1).
Disabled, 1200, 2400, 4800, 9600, 19200, 38400, 57600
None, Odd, Even
7, 8
1,2
Full Duplex no HW handshaking, Full Duplex HW handshaking, Half Duplex
The maximum time the eWON will wait for a valid FINS message response
(applicable for ethernet and serial interface).
Source Network Address (SNA) filled in a FINS request message originating from the eWON and sent out on the ethernet interface.
Table 86: FINS IO server COM setup configuration fields
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 121
General Reference Guide IO Servers Configuration
Ethernet FINS node
Serial FINS network
Serial FINS node
Source Node Address (SA1) filled in a FINS request message originating from the eWON and sent out on the ethernet interface. It uniquely identifies the eWON on the ethernet network.
Source Network Address (SNA) filled in a FINS request message originating from the eWON and sent out on the serial interface.
Source Node Address (SA1) filled in a FINS request message originating from the eWON and sent out on the serial interface. It uniquely identifies the eWON on the serial network.
Table 86: FINS IO server COM setup configuration fields
(1) For the eWON Flexy: The numbering of the serial COM ports starts with the serial port of the Base Unit (if available) and then continues with the upper port of the first Extension Module starting from the left. A maximum of 5 serial ports are supported.
Warning: When there are multiple IO servers potentially using the serial line, the unused IO servers must be cleared or the baudrate must be set to Disabled. Example: if Modbus and FINS servers are available, at least one of them must have its baudrate configured to Disabled. If not, one of the IO servers will not be able to use the serial line and it will be disabled, with an error written in the event log.
5.7.2.2
Topic Configuration
Figure 93: FINS IO server topic configuration
Three (3) topics can be used for the IO Server. These topics are used to give a common property to a group of FINS Tags like:
• Enable/Disable
• Protocol
• Global Device Address
• Polling Rate
Topic configuration item
Topic enabled
Protocol
Global Device Address
Poll rate
Description
Enables or disables the polling of all the Tags in the topic.
Protocol used for the tags belonging to this topic: FINS Serial, FINS UDP, FINS
TCP.
See below for the Device Address Syntax. If an address is specified here, it will replace (overload) the address-defined Tag by Tag.
Defines the refresh rate of the Tag name. In a complex application, we can imagine that some Tag names must be refreshed every second - typically for digital input - and other every minute - typically: temperature-.
Table 87: FINS IO server topic configuration fields
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 122
5.7.2.3
Gateway Configuration
The following parameters can be modified:
General Reference Guide IO Servers Configuration
Figure 94: FINS IO server gateway configuration
FINS TCP Server Node
Routing Entry 1..4
The eWON FINS server node address used during FINS TCP session establishment (exchange of the FINS node address messages, and allocation of a
FINS TCP Client node if necessary).
For each defined destination network, gives the matching relay destination node.
This is used to fill in the host link unit ID in the hostlink frame which encapsulates the FINS message sent out on the serial interface.
Table 88: FINS IO server gateway configuration fields
5.7.3
Tag Name Convention
IO Server configuration
IO Server Name
Topic Name
Item Name
B
C
FINS
A
ValueName, FINS Network, FINS Node, Hostlink or
Ip Address
ValueName
If FINS Serial has been chosen at topic level,
Hostlink value has to be defined.
If FINS UDP or FINS TCP has been chosen at topic level, IP address has to be defined.
Topic PLC Address is used.
Table 89: FINS IO server - Tag name convention table
The Item Name can contain the PLC address where the value is polled, or not. If address is also specified at the topic level, the address specified at the Tag level will be ignored.
5.7.3.1
Value Name
5.7.3.1.1
General Description
The format of value names for data from CS/CJ OMRON controllers is shown below. Its is based on the naming convention used by the CX
Programmer programming software. The format is shown below (The parts of the name shown in square brackets are optional).
General Value Name Format: X[bank number:][modifier]word address[#bit address]*
• X identifies the Memory area acronym.
• [bank number:] is only supported by the E memory area. Values 0 to max values for memory area.
• [modifier] allow you to interpret the data in a specific type (Word if omitted).
• [#bit address] is only supported by A, D, CIO, H and W memory areas. Values 0 to 15.
*items between brackets "[]" are optional (the brackets should not be used!)
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 123
General Reference Guide IO Servers Configuration
Supported memory areas:
H
T
D
E
W
X
A
C
CIO
Memory area
Auxiliary area
Counter area
Core I/O area
Data Memory area
Extended Data Memory area
Holding area
Timer Area
Work Area
Table 90: FINS IO server supported memory areas table
Modifier:
Symbol
D
L
W
S
F
Modifier
Word (default) signed Word
DWord signed DWord
Float
value range
0 .. 65535
-32768 .. 32767
0 .. 4294967296 (*)
-2147483648 .. 2147483647 (*)
+/- 3.4e38
Automatic
Tag type
DWord
Integer
DWord
Integer
Float
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
examples:
Table 91: FINS Modifiers address
A5
AS5
A2#5
E0:S3
C5
D4 point to
the Word at address 5 in the Auxiliary Area (equivalent to AW5) the Signed Word at address 5 in the Auxiliary Area the bit 5 from the Word at address 2 in the Auxiliary Area the signed Word at address 3 from the Extended Data Memory 0 the Counter at address 5 the Data Memory at address 4
Table 92: FINS address examples
• Status register:
The STATUS Tag is a special Tag that returns information about the current state of communication for a given device. As for the other Tags, the status Tag ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each PLC used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 93: Tag Status meaning
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 124
General Reference Guide IO Servers Configuration
5.7.3.2
Global Device Address
The global device address is used in the topic definition or in the Tag definition. If it is used in the Tag definition, it will be separated from the value name by a coma.
• Format: or
Network,Node,HostLink
Network,Node,IP
Figure 95: FINS IOServer topic setup
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 125
General Reference Guide IO Servers Configuration
5.8 S5-AS511 IO Server
5.8.1
Introduction
This IO server is intended for use with Siemens S5 PLCs communicating via the front programming port using AS511 protocol.
The AS511 protocol is specific for each Siemens device. This IO Server has been designed to operate with a set range for Siemens equipment.
Use of the IO Server on devices other than those listed is not recommended and not supported.
The Siemens S5 PLC family has a unique memory structure. Data within the PLC are not located at fixed locations within the PLC's memory space. This memory space is continuously updated and revised as you create and modify your PLC logic. When these revisions occur, the location of key data elements such as flags, timers, counters, I/O and data blocks can move around in the PLC's memory. The Siemens S5 IO
Server has been designed to read the location of these memory elements when the driver first begins operation upon detecting a communication error or after a request (which is not a read or a write request) has been transmitted to the PLC. If you change your PLC configuration you must restart the Siemens S5 IO Server or simply unplug/re-plug the connection cable. Both actions will cause the Siemens S5 IO Server to reacquire the location of all PLC memory elements.
5.8.2
Setup
Figure 96: S5-AS511 IO server setup window
For the eWON Flexy: The numbering of the serial COM ports starts with the serial port of the Base Unit (if available) and then continues with the upper port of the first Extension Module starting from the left. A maximum of 5 serial ports are supported.
Warning: When there are multiple IO servers potentially using the serial line, the unused IO servers must be cleared or the baudrate must be set to Disabled. Example: if Modbus and S5-AS511 servers are available, at least one of them must have its baudrate configured to Disabled. If not, one of the IO servers will not be able to use the serial line and it will be disabled, with an error written in the event log.
5.8.3
Communication setup
The AS511 link uses a RS-232 Current Loop functioning mode.
A specific cable (with electronic) is therefore required (Siemens S5 Cable : ACT’L ref EW40910)
The communication parameters are fixed to the following values:
• 9600 Baud (Fixed)
• Even Parity (Fixed)
• 8 Data Bits (Fixed)
• 1 Stop Bit (Fixed)
• Full duplex no handshaking (Fixed)
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 126
General Reference Guide IO Servers Configuration
5.8.3.1
Supported Devices
• Siemens S5 - 90U
• Siemens S5 - 95U
• Siemens S5 - 100U - 100
• Siemens S5 - 100U - 101
• Siemens S5 - 100U - 103
• Siemens S5 - 101U
• Siemens S5 - 115U - 941
• Siemens S5 - 115U - 942
• Siemens S5 - 115U - 943
• Siemens S5 - 115U - 944
• Siemens S5 - 115U - 945
Table 94: Siemens S5 devices supported by the eWON AS-511 IO server
5.8.4
Tag name convention
IO server Name
Topic name
Item Name
S5-AS511
A or B or C
ValueName, ComPortNum
ValueName
COM port is defined Tag by Tag
Topic COM port is used (or default)
Table 95: S5-AS511 IO server Tag name convention table
ComPortNum: The port number used to access the PLC; if not specified, the default COM port is used.
• If a port address is specified in the topic, it is used and overloads per Tag address.
• If no address is specified, neither in the topic, nor at the Tag level, then the default port is used (Default port is the ECIA Port -
COM:1).
5.8.4.1
ValueName
Syntax
DBxLy
DBxYy
DBxRy
DBxZy
DBxWy
DBxSy
DBxDy
Tx or Kx
Cx or Zx
MxB or FxB
MxW or FxW
MxD or FxD
Ix or Ex
Qx or Ax
Description
Data block x Word offset y, left byte of word (0 - 255)
Data block x Word offset y, left char of word (-128 - 127)
Data block x Word offset y, right byte of word (0 - 255)
Data block x Word offset y, right char of word (-128 - 127)
Data block x Word offset y, full word (0 - 65535)
Data block x Word offset y, integer (-32768 - 32767)
Data block x DWord offset y (0 - 4294967296 ) (*)
Timer x (0-65535)
Counter x (0-65535)
Memento as Byte
Memento as Word
Memento as DWord (*)
Input
Output
DWord
DWord
DWord
DWord
DWord
DWord
DWord
DWord
Automatic
Tag type
DWord
Integer
DWord
Integer
DWord
Integer
Table 96: S5-AS511 IO server value names
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
• Bit access modifier:
In any of the above items, it is possible to access a single bit.
#x must be appended to the Value Name (Bit index goes from 0..31).
The syntax can be used for reading bits and for writing them as well.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 127
General Reference Guide IO Servers Configuration
Example:
DB1W13#3 represents bit 3 of W13 in DB 1
Q32B#0 represents bit 0 of Q32.
Note that you must define the type byte (B) to successfully extracts a bit (Q32#0 will not work).
REM:
Bit index range depends on item referenced (for W, bit index maximum value is 15)
NOTES:
• For DB the smallest element is a WORD and we count addresses in Word.
This means that DB1W0 and DB1W1 WILL NOT overlap.
• Timers and Counters are always Words and addresses are counted in WORD as well.
This means that T0 and T1 WILL NOT overlap.
• For M, I, Q addresses are counted in BYTES.
This means that M0W and M1W WILL overlap.
• Both syntax (German and English) can be used for I, Q, C
which in German gives: E, A, Z.
• Status register:
The STATUS Tag is a special Tag that returns information about the current state of communication for a given device. As for other Tags, the status Tag ValueName is composed of:
Status,ComPortNum
• You can define a status Tag for each COM port used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 97: Tag status meaning
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 128
General Reference Guide IO Servers Configuration
5.9 ABLOGIX IO Server
5.9.1
Introduction
ABLogix IO server is used to communicate with Allen Bradley Logix Series PLCs on the Ethernet link or on the Serial link (in DF1 protocol).
• It allows the eWON to poll ABLOGIX PLCs in order to read data.
• It allows the eWON to act as EIP-DF1 gateway for remote maintenance of the ABLOGIX PLCs.
• It allows the eWON to poll DH+ device using ControlLogix gateway.
The eWON only allows DF1 communication with devices directly connected to the eWON Serial link (the ABLOGIX PLC may not be located behind another PLC connected on the DF1 serial link acting itself as gateway).
note: Please check in the “Rockwell compatibility matrix” on page 236 if your device is supported.
5.9.2
Setup
Figure 97: ABLOGIX IO server setup window
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 129
General Reference Guide IO Servers Configuration
5.9.2.1
Communication Setup
In the current implementation, the serial link configuration may be done using the DF1 IO Server configuration page or the AB LOGIX IO server page.
The same settings apply for both IO servers (DF1 and ABLogix).
note: In the config.txt file the serial link parameters are defined in the DF1 IO server entry.
Field name
COM Port
Baud Rate
Parity
Stop Bit(s)
Frame Error Detection
HW mode
Master Response Timeout
Rx message timeout (MSEC)
Tx message timeout (MSEC) eWON DF1 address
Destination DF1 address
Bridge EIP connection
Description
Physical COM Port allocated to the ABLOGIX IO Server.
Note: The port selection drop down is not displayed if the eWON has only one single serial port. For multiple serial ports see remark (1).
Select the Baudrate from 1200 to 38400 Bauds
The parity to apply: none / odd / even
Number of stop bits
Cyclic Redundancy Check (CRC) or Block Check Character (BCC)
Full Duplex no handshaking or Half duplex
Maximum time the eWON will wait for a valid message from the DF1 master. This value can be critical for a correct operation, depending on the responsiveness of the master. A value of
1000 should be selected to guarantee correct operation
Maximum time between a request is posted and the response is received
Maximum time for a request to be sent
Device Address of eWON on DF1 link
When the eWON acts as a DF1 slave, it will respond to 2 consecutive link addresses; doing this improves the throughput of data across the eWON when acting as a gateway. (eWON
DF1 address and eWON DF1 address +1)
Device Address of Destination on DF1 link when EIP is used
When bridging is configured, EIP connections requests are forwarded to the PLC on the DF1 interface (mandatory for Logix family). This is the default configuration.
When not configured, connection requests are cancelled by the eWON (must be disabled for
SLC family).
Table 98: ABLOGIX-DF1 communication setup controls
(1) For the eWON Flexy: The numbering of the serial COM ports starts with the serial port of the Base Unit (if available) and then continues with the upper port of the first Extension Module starting from the left. A maximum of 5 serial ports are supported.
Warning: When there are multiple IO servers potentially using the serial line, the unused IO servers must be cleared or the baudrate must be set to Disabled. Example: if Modbus and ABLOGIX servers are available, at least one of them must have its baudrate configured to
Disabled. If not, one of the IO servers will not be able to use the serial line and it will be disabled, with an error written in the event log.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 130
General Reference Guide IO Servers Configuration
5.9.2.2
Topic configuration
Three topics can be used for the IO Server. These topics are used to give a common property, to a group of Tags, like:
• Enable/Disable
• Global Device Address
• Poll rate
Topic configuration item
Topic enabled
Global Device Address
Poll rate
Description
Enables or disables the polling of all the Tags in the topic
The Global Device Address is a global parameter for all the Tags of the topic. See below for the Device Address syntax. If an address is specified here, it will replace (overload) the address defined Tag by Tag
Defines the refresh rate (in mSec) of the Tag name. In a complex application, we can imagine that some Tag name must be refreshed every second – typically for digital input - and other every minute – typically: temperature-
Table 99: ABLOGIX topics configuration setup
5.9.2.2.1
ABLogix : DF1 serial link
The Global Device Address has the following syntax: Address
•
Address
= DF1 Node ID of the device (i.e.: 5)
Figure 98: ABLogix : DF1 address example
5.9.2.2.2
ABLogix : EIP Ethernet link
The Global Device Address has the following syntax : IP Address,Port,Link
• IP Address = address on your Ethernet network (i.e.: 10.0.30.7)
•
Port
= value from 1 to 3 representing: 1 = Backplane, 2 = Channel A, 3 = Channel B
•
Link
could be:
¤ Slot: representing the Slot on the Backplane (for example: 0=CPU)
¤ Node ID: value from 0 to 99 (for ControlNet)
¤ IP address
Figure 99: ABLogix : EIP address example
REM: In the case of using a ControlLogix as Gateway, the Device Address could be like following: IP Address, Port, Link[,
Port,Link][, Port,Link]…
5.9.2.2.3
DH+ polling using ControlLogix gateway
This feature allows the eWON to poll PLC tags located on a DH+ network, behind a controllogix equipped with one or more DHRIO cards.
Polling is done using the eWON EIP protocol.
The ABLOGIX IO server is used to access the "LOGIX" PLC family.
The general syntax IP address,Port,Link is still applicable. There is no specific character to indicate the DH+ channel ("2" or "3" should be used).
Example: To reach a SLC500 (with CPU in slot 0) with DH+ node Id 3 using channel A of a DHRIO card at slot 9 of a controllogix at IP address
10.0.30.21.
Topic A Destination = SLC500-10.0.30.21,1,9,2,3,1,0
•
10.0.30.21
= IP address of the ControlLogix
•
1
= BackPlane
•
9
= Slot 9 (COM card)
•
2
= Channel A (of the Card present in Slot 9)
•
3
= NodeID of the PLC5 (in the COM network)
• 1 = BackPlane
• 0 = slot (of the CPU in our example)
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 131
General Reference Guide IO Servers Configuration
5.9.3
Tag name convention
IO server Name
Topic name
Item Name
IO Server Configuration
ABLOGIX
A or B or C
ValueName Topic PLC address is used
ValueName, IP address[, Port, Link] PLC address is defined Tag by Tag
ValueName, NodeID PLC address is defined Tag by Tag
Table 100: ABLOGIX IO server Tag name convention table
The Item Name can contain the PLC address where the value is polled, or not. If the address is also specified at topic level, the address specified at Tag level will be ignored.
5.9.3.1
ValueName
ValueName follows the below syntax:
[PROGRAM:ProgName.]SymbolicTagName
• ProgName is the name of the program where the Tag is.
If no ProgName, the Tag is in the global scope (tag is controller type)
• SymbolicTagName:
• Symbol of the tag.
Only following atomic type are supported: BOOL, SINT, INT, FLOAT, DINT (*), BIT ARRAY
• Bit selection with <SymbolicTagName>/bit where bit is the bit number (from 0 to 31) ex: controlbit/4 read the bit 4 of the controlbit register
• TIMER, CONTROL, COUNTER predefined types with <SymbolicTagName>.acc (or ctl or pre) ex: MyVar.acc read the counter of MyVar
• Element of a table
<Symbol_1>[idx_1].<Symbol_2>[idx_2].<Symbol_3>[idx_3].<Symbol>
With maximum 3 index.
ex: table1[2].subtable[6].element read data named 'element' on the index 6 of the 'sub table' from the index 2 of the 'table1'
• Element of a structure
<Symbol_1>.<Symbol_2> ex: CounterObj.init read the 'init' part of the structure 'CounterObj'
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
If you choose “Automatic” Tag type, eWON will use Floating Point as storaeg type.
examples: address myvar point to
the data named “myvar” in the scope global (controller) of the PLC
PROGRAM:myprog.myvar
myvar/4 mystruct.mydata
mytable[6] mytablestruct[4].mydata[12]
the data named “myvar” in the scope of the program named “myprog” the bit 4 (the fifth) from the data “myvar” the data named “mydata” from the structure named “mystruct” the element 6 (the seventh) of the table “mytable” the element 12 of the table “mydata” from the structure at index 4 of the table “mytablestruct”
Table 101: ABLogix address examples
• Status register:
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 132
General Reference Guide IO Servers Configuration
The STATUS Tag is a special Tag that returns information about the current state of communication for a given device. As for other Tags, the status Tag ValueName is composed of:
Status,GlobalDeviceAddress
• You can define a status Tag for each COM port used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 102: Tag status meaning
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 133
General Reference Guide IO Servers Configuration
5.10 eWON IO Server
5.10.1
Introduction
The eWON IO server is used to interface the eWON INPUTS and OUTPUTS.
Depending on your eWON model, you have:
eWON types
Digital Inputs
Digital Outputs
Analog Inputs
500, x001, x101, x005[CD], x104
4002
Flexy 10x - 20x
(Base Units)
1
1
0
9
3
6
Table 103: eWON Inputs/Outputs
2
1
0
Flexy
FLX 3401
(Extension Card)
8
2
4
Additionally, there are a number of Tags that can be addressed with this IO server and which are computed by the eWON IO Server.
These additional Tags are used for energy management. In Energy management, the following requirements are taken into accounts:
• Using digital inputs as counter inputs
• Count for a given interval and latch computed result (also save it in historical)
• Reject the measurement interval if too long or too short
• Adjust the eWON’s Real Time Clock based on a digital input
These Tags will be computed if the energy module is enabled.
There is no topic name to define for the eWON IO server.
5.10.2
Standard eWON I/O Item Names
5.10.2.1
Tag address convention
The following Tags addresses are available for standard eWON Inputs & Outputs access:
IO Server configuration
IO Server Name EWON
Topic Name
Item Address
Empty
DI#
CI#
FI#
LI#
DO#
AI#
BI#
Digital Input (1)
Counter Input (1)
Counter Input
Latched Counter Input (1)
Digital Output (1)
Analog Input (1)
Button Input (1)
Comment
0 to 2.147.400.000(2)
0 to 255
Table 104: eWON IO server configuration parameters - no topic defined
Boolean
Analog
Analog
Analog
Boolean
Analog
Boolean
NOTE:
The button input (BI1) can be used during normal eWON operations, if it is pressed for more than 4 seconds while the eWON is
).
(1) The number of items depend of the eWON type. See
. For the eWON Flexy range, the numbering of the
IOs starts with the embedded IOs of the Base Unit and continues with the first IO Extension Card starting from the left (if available).
More information on this subject is given below Table 106 on page 136
(2) From firmware 4.1S3 to 4.3, the CIx value wrapped at 1.000.000. Before 4.1S3, the CIx was misinterpreted as negative when value passes over 2
31
.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 134
General Reference Guide
IO Server configuration
IO Server Name
Topic Name
Item Address
EWON
SYS
SN_LO
SN_HI
SYS_UP
GSM_REG
Comment
Serial number, low part (see example of use below)
Serial number, high part (see example of use below)
Number of seconds since Power Up
GSM Status:
1: Home network
2: Searching registration
3: Registration denied
4: unknown registration
5: Roaming
100: Not applicable
101: Registration in progress usually:
1 or 5: means registered
Other: not registered
GSM level (antenna reception)
GSM_LEV
Table 105: eWON IO server configuration parameters - SYS topic
Example of use of SN_LO and SN_HI items in a Basic program:
a% = Int(SN_HI@ * 65536) + Int(SN_LO@)
Rem Product code b% = a% Mod 256
Rem Sequential number c% = Int(a% / 256) Mod 1024
Rem Week number d% = Int(a% / 262144) Mod 64
Rem Year number e% = Int(a% / 16777216) Mod 128
Print "SN: ";e%;" ";d%;"-";c%;"-"b%
For instance, you can define a Tag for the digital input 1 as follows:
Server name
: EWON -
Topic
: empty -
Address
: DI1
IO Servers Configuration
DWord
DWord
DWord
DWord
DWord
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 135
General Reference Guide IO Servers Configuration
Syntax Description eWON500 eWON2001(CD), eWON4001(CD) eWON2101(CD), eWON4101(CD) eWON2005(CD) eWON4005(CD) eWON2104, eWON4104 eWON4002 eWON4102 eWON Flexy 1xx eWON Flexy 2xx
Base Units only.
See note beow.
DI1
CI1
LI1
DO1
BI1
DI1... DI8
CI1... CI8
LI1... LI8
DI9
CI9
LI9
DO1... DO2
DO3
BI1
AI1... AI4
AI5... AI6
DI1... DI2
CI1
LI1
DO1
BI1
Status of input 1 on connector Input/output (bottom side)
Counter on input 1 on connector Input/output (bottom side)
Latched counter on input 1 on connector Input/output
Digital command of output 1 on connector Input/output
Status of button (reset) on the front face
Status of input 1 to 8 on connector DI1-DI8 (top side)
Counter on input 1 to 8 on connector DI1-DI8 (top side)
Latched counter on input 1 to 8 on connector DI1-DI8 (top side)
Status of input 9 on connector Input/output (bottom side)
Counter on input 9 on connector Input/output (bottom side)
Latched counter on input 9 on connector Input/output
(bottom)
Digital command of relay 1 and 2 on relay connector (bottom side)
Digital command of output 1 on connector Input/output
(bottom)
Status of button (reset) on the front face
Value of analog input 1 to 4
Value of analog input 5 to 6 (PT100 probes)
Status of input 1 and 2 on the Base Unit main connector
Counter on input 1 and 2 on the Base Unit main connector
Latched counter on input 1 and 2 on the Base Unit main connector
Digital command of relay 1 on the Base Unit main connector
Status of button (reset) on the front face
Table 106: Available Items depending on eWON product type
Automatic
Tag type
Boolean
DWord
DWord
Boolean
Boolean
Boolean
DWord
DWord
Boolean
DWord
DWord
Boolean
Boolean
Boolean
DWord
DWord
Boolean
DWord
DWord
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 136
General Reference Guide
5.10.2.2
Basic Pinciple of the eWON Flexy I/O Tag Addresses
The internal I/O tag addresses of the eWON Flexy always start with the Inputs/Outputs of the Base Unit. Remember that all Base Units feature 1 Digital Output and 2 Digital Inputs, those are the first ones that have to be considered when creating tags in the eWON.
The example on the right helps you to understand the syntax of the
I/O tag addresses in the case of 2 I/O Extension Cards.
In the case of multiple I/O cards, the tag numbering sequence is following the left-to-right order of slots. First the I/O Extension Card plugged in the most left slot, then the next on its right and so on.
Removing an I/O card other than the utmost right one will result in an internal reallocation of tag addresses that may result in a mismatch between physical I/Os and their software configuration.
The software tag addresses can be “frozen” by adding the slot number in the tag definition. This prevents unwanted I/O mismatch
(see below).
Slot number append to prevent tag address mismatch:
To prevent any risk of mismatching tag addresses you can append the slot number after the I/O address.
The syntax to use is as follows:
ABx,Ey
Where AB is the type of I/O (DI, AI, DO) x is the order number
E is a constant prefix to the slot number y is the slot number of the card (0 = main board, 1 = slot #1, 2 = Slot #2, etc..)
Let’s imagine an eWON Flexy featuring 2 I/O cards FLX 3401 in slots #2 and #3.
IO Servers Configuration
The main I/O syntax and order numbering remains unchanged.
In the example above, the I/O server tag addresses are as follows:
Tag Syntax
DO1,EO
DO2
DO3,E2
DO4,E3
DO5,E3
Explanation
Digital Output 1, main board (though E0 is not necessary in this case)
Digital Output 2, no position specified = second detected DO = first DO on first extension card detected (in slot #2 most left).
Digital Output 3, board in slot #2 = second DO on extension card in slot #2
Digital Output 4, board in slot #3 = first DO on extension card in slot #3
Digital Output 5, board in slot #3 = second DO on extension card in slot #3
Behavior if the card in slot #2 is removed:
In the Tag View page,
• DO2 will appear normally as it was not frozen by a slot number append. But it can no longer reflect the status of the first DO of the board in slot #2 that was removed. DO2 now reflects the status of the first DO of the board in slot #3.
• The 3 other DOs with specified slot number E2 and E3 will all appear in error (red cross, value 0), because: a) The address of DO3,E2 of the card in slot #2 could no longer be found, and b) The software addresses of DO4,E3 and DO5,E3 of the card in slot #3 do no longer match with the detected order of physical addresses.
The error messages in the Trace log file are “Invalid IO Tag name (DOx, addr. DOx,Ex)”.
To have the DOs of the card in slot #3 responding, edit the tags and change their software addresses as follows:
DO4,E3 to DO2,E3 and
DO5,E3 to DO3,E3.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 137
General Reference Guide IO Servers Configuration
5.10.2.3
Energy configuration with the LIx Tags
The following parameters can be added to the eWON IO server in order to activate the energy support (enter Energy:1, validate and the other parameters will be automatically added):
Parameter
Default
Value
Energy
Debug
RefTime
IntTime
IntTolS
SyncIO
SyncTolS
0 or 1
0 or 1
15
5
5
5
Enabled or not
Once Energy is defined, the eWON will automatically add the other parameters with default value.
When 0, no energy computation at all are performed, saving eWON CPU resources.
Not automaticaly added
When :1 all synchonisations are logged in the Real time event log.
This is the reference time to compute interval. Letting this empty will start at 1/1/1970 00:00. You may enter a date with hour in the form 08/07/2002 11:15:00 to set a new reference (usually not required).
This is the integration time in MINUTES.
This is a tolerance on the integration time in SECONDS. If the measurment interval is shorter or longer than this number of seconds, the period is considered as valid. For example IntTime=15 IntTolS =5 means
"interval is valid if between 11.14:55 and 11.15:05".
This is the IO number for clock synchronization. 0 means no synchro available, 1..8 is the IO number.
Synchonisation is based on the counter input associated with the digital input, each time the IO changes the eWON will try to perform a synchronization (see also
SyncTolS
)
This is the tolerance for accepting the synchronization pulse in SECONDS.
If the synchronization pulse arrives outside the interval, the pulse is rejected. ERROR REPORT: the first time the pulse is rejected, an error is logged in the event log. Next errors are not logged (except in Real time log if Debug is enabled); When sync are accepted again, a trace is logged in the event file for the first accepted synchonization.
REM: Because the internal clock has a precision of 1 second, the time is only updated if the absolute value of the offset is greater than 1 (2 or more). Otherwise the offset jitters between -1 and +1 all the time.
Figure 100: Energy IO server parameters
Figure 101: eWON IO server default parameters
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 138
General Reference Guide IO Servers Configuration
5.10.2.3.1
ENERGY TAGS
The following tags are available for energy management:
LI1..LI8
Latched input
ST1..ST4
ST1
Latch time - 0x30000000
ST2
Period status
ST3
Period length sec
When the Integration Period expires, the number of pulses counted during the integration period are logged in the corresponding LIx.
Status variables:
This is the absolute time when counter were latched.
Expressed in seconds since 1/1/1970 minus 0x30000000 HEX (or 805306368 decimal).
This huge value is substracted to maintain precision in the Float storage. (*)
0 means period is valid (within tolerance), 1 means period is invalid.
Length of the period in second.
ST4
Period Num
This 32 bit counter counts is increased by 1 after each integration period. It can be used with
ONCHANGE to perform operations when period expires.
REM1: Energy tags are logged after each new period IF Logging is enabled, even if the value has not changed since previous period.
REM2: Even if Deadband is -1 and Interval is 0. If not, you will have additional points and even maybe duplicate points.
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
5.10.2.3.2
32 BIT COUNTER TAGS:
The eWON IO Server provides 8 32 bits (*) counter tags named: CI1..CI8. These counters are writable but writing in these registers affects the
LIx inputs of the Energy IO server module.
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 139
General Reference Guide IO Servers Configuration
5.10.2.4
Analog Input Value Ranges (eWON4002 & Flexy)
On the eWON4002, the Analog Inputs (AI1 to AI6) are processed by a 12 bit ADC. The converted values range from 0 to 4095.
On the eWON Flexy Extension Card FLX 3401, the Analog Inputs (AI1 to AI4) are processed by a 16 bit ADC. The converted values range from
0 to 65535.
5.10.2.4.1
eWON4002 Configurable analog input AI1 to AI4
• In 0-10V mode
AI#
0
4095
Volt
0
10
If you need to read the Tag value converted in Volt, you can set a factor of 0.0024420 = 10/4095 with an offset of 0.
Figure 102: Tag’s configuration: reading the tag value in Volt (eWON4002)
• In 0-20 mA mode
The shunt resistor for measuring current is a 220 Ohm.
AI#
0
1802
mA
0
20
If you need to read the Tag value converted in mA, you can set a factor of 0.011099 = 20/1802 with an offset of 0.
Figure 103: Tag’s configuration: reading the tag value in mA (eWON4002)
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 140
General Reference Guide IO Servers Configuration
5.10.2.4.2
eWON4002 PT100 input AI5 and AI6
These two inputs measure a Resistance value in Ohm.
AI#
0
4095
Ohm
162.13
79.625
As you can see, the slope is negative, and if you need to read the Tag value converted in Ohm, you can set a factor of -0.02014774 = -82.505/
4095 with an offset of 162.13.
Figure 104: Tag’s configuration: reading the tag value in Ohms (eWON4002)
If you need to convert into °C: temperature = AI * (-0.0523311) + 161.376.
The default range of PT100 in eWON is -50°C to 150°C.
Full range of ADC is: -52.92°C to 161.376°C (79.625 Ohm to 162.13 Ohm).
Note:
• eWON 4002 models prior to S/N 0517-xxxx-89 have a PT100 range from 0°C to 131.9°C and must apply the following formulas:
Ohm = IOValue * (-0.012402) + 150.8
°C = IOValue * (-0.0322) + 131.9
• eWON 4002 models from S/N 0517-xxxxx-89 to S/N 0521-xxxx-89 have a PT100 range from -56°C to 151°C and must apply the following formulas:
Ohm = IOValue * (-0.0195068) + 158.2
°C = IOValue * (-0.050677) + 151.2
5.10.2.4.3
eWON Flexy Extensions Card FLX 3401 analog inputs AI1 to AI4
AI#
0
65535
Volt
0
10
If you need to read the Tag value converted in Volt, you can set a factor of 0.0001526 = 10/65535 with an offset of 0.
Figure 105: Tag’s configuration: reading the tag value in Volt (Flexy FLX 3401)
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 141
General Reference Guide IO Servers Configuration
5.10.3
Setup
The Energy IO Server is based on the eWON IO Server. The configuration consists in advanced parameters from the latter IO Server. The following screen shot shows the standard empty eWON IO Server configuration page.
Figure 106: eWON IO server configuration page
5.10.3.1
Configuration of the counter pulse length
The pulse length for counter can be configured on all the eWON types.
The configuration must be entered in the eWON IO server edit area.
The following parameters are used:
MinInterval:
MaxInterval:
default=10, min=10 default=268435455, max=268435455
MinInterval and MaxInterval are entered in milliseconds
ReverseCount:
default=0
The pulse length must be between MinInterval and MaxInterval to be accepted, the measurement resolution is 5 msec (the precision of the pulse length measured is 5 msec)
ReverseCount can be used if pulses entered in the eWON are reversed, reversed means that signal is normally high on the eWON input and it goes low when the pulse occurs.
Table 107: counter pulse length configuration
Example of configuration:
MinInterval:40
MaxInterval:1000
ReverseCount:0
Counts pulse with length longer than 40 msec and shorter than 1000 msec, other pulses are ignored.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 142
General Reference Guide IO Servers Configuration
5.11 MEM IO Server
5.11.1
Introduction
The MEMORY IO Server is not a real IO server because values do not come from a peripheral. Memory Tags (Tags defined with the MEM IO server) are rather sorts of variables that can be modified by a user input or by a BASIC application. These Tags are very useful for combining different Tags and consider the result as an actual Tag i.e. having data logging capabilities and alarm management capabilities like for all other
Tags.
5.11.2
Setup
There is no setup for the MEM eWON IO server.
5.11.3
Tag name convention
IO Server Name
Topic Name
Item Name
IO Server configuration
MEM
RET
DON’T CARE
If no topic is specified, the Tag is a standard memory Tag. Its value is set to 0 when the eWON boots and the Tag is read/write, it can be updated through user actions with script or web pages
If topic is set to RET, the Tag is retentive, each change is saved to flash and when the eWON boots, the last value of the Tag is restored. This feature can be convenient to use Tags as parameters.
The MEM "Item Name" is insignificant, the TagName is automatically copied in the MEM address by the eWON, the user can change it, but the value will immediately be overwritten again by the TagName.
Data type “Automatic” is equivalent to Floating Point.
Table 108: MEM IO server Tag name convention
Important: RET values are saved in the FLASH memory, this is not an immediate operation and the FLASH memory can only be written and erased a limited (even if huge 100.000) number of times. This means that you should not use a BASIC script for changing retentive values at very high rate. 1 Tag/Sec. is a maximum AVERAGE rate (occasional higher rates are not prohibited at all).
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 143
General Reference Guide IO Servers Configuration
5.12 S7-300&400 (MPI/Profibus - ISOTCP)
5.12.1
Introduction
S73&400 IO Server is dedicated to communicate directly with SIEMENS PLC (S7-300 & S7-400).
The eWON will connect directly to the PLC’s MPI interface or Profibus DP interface.
WARNING: The MPI/Profibus interface requires a special serial port hardware!
ONLY the eWONs MPI/Profibus are able to communicate in MPI/Profibus eWON product codes like EWxxx6x (i.e.: EW41264 eWON4001 MPI with pstn modem) eWONs MPI/Profibus have a coloured (in light blue) square around DB9 connector labelized MPI (see photos on right).
eWONs MPI/Profibus (no CD series) have a Serial Gender-Changer fixed on DB9 connector to provide female DB9 connector.
Others Serial IO Server (i.e.: modbus RTU, DF1, UnitelWay) are not available on eWON
MPI/Profibus.
The ISOTCP (Ethernet) is available on all eWON types.
With an eWON500 (with a standard Serial Port), you can have access to a S7-300&400 Siemens PLC by Ethernet thanks to the ISOTCP protocol.
With an eWON500-MPI, you can have acces by the MPI port and by ISOTCP to your S7-300&400, if it has both interfaces.
Multi-Session: Since firmware 5.4, the ISOTCP-MPI gateway allows multiple clients to access the same PLC at the same time.
5.12.2
Setup
5.12.2.1
COM configuration
Parameter
Gateway MPI/Profibus
Destination Node
Protocol Type
Figure 107: MPI link configuration
Description
Identifies the PLC MPI/Profibus Destination address when ISOTCP is used
Select protocol MPI or PROFIBUS.
As the MPI port configuration is shared by the S73&400 and the S7-200
IOServers, this combo box shows also the PPI MULTIMASTER protocol (See
"S7-200 (PPI - ISOTCP)" on page 151)
.
PPI MultiMaster and MPI/Profibus are mutually exclusive. It is not allowed to use the S7-200 and the S73&400 IOServers on the MPI port at the same time
Table 109: MPI/Profibus settings
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 144
General Reference Guide IO Servers Configuration
Baud Rate
Reply Timeout
MPI Address
MPI Highest Station Address
Speed of the MPI port.
Available speeds are:
• disable
• 9.6 kBauds
• 19.2 kBauds
• 45.45 kBauds
• 93.75 kBauds
• 187.5 kBauds
• 1.5 MBauds
• 3
MBauds (only for eWON CD-MPI)
• 6
• 12
MBauds (only for eWON CD-MPI)
MBauds (only for eWON CD-MPI)
The maximum time the eWON will wait for a valid MPI message response
The device address of the eWON on the MPI link (0..126, default is 0)
The highest station address polled by eWON. Select between 15, 31, 63 or
127.
Table 109: MPI/Profibus settings
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 145
General Reference Guide IO Servers Configuration
5.12.2.2
Advanced Routing Setup
Advanced Routing Setup is a feature that has been introduced from firmware version 6.3 onwards.
It allows to access devices that make part of an other MPI/Profibus network connected indirectly to the eWON through another (or various other)
PLC(s).
Advanced Routing Setup items are visible when the Enable checkbox is ticked.
Note: Parameters that would have been set in this section remain in memory but are visually hidden AND not taken into account by the firmware when the Enable checkbox is unticked.
Figure 108: Advanced MPI configuration screenshot
Parameter
Advanced Routing Setup
Gateway/Destination
S7-Subnet ID:
Description
Enable/disable Advanced Routing Setup feature
Used when no subnet ID is specified in the ISOTCP message to relay on the MPI bus
ISOTCP S7-Subnet ID:
eWON subnet ID at the ISOTCP interface side
MPI/PROFIBUS S7-Subnet ID:
Default Next MPI/PROFIBUS Node:
Gateway Entry 1..3
Destination S7-Subnet ID
eWON subnet ID at the MPI interface side
MPI node of the PLC towards which the MPI messages will be sent out if the destination subnet ID specified is not the one of the eWON (see previous field), nor one of the ones specified in the gateway entries (see next fields)
MPI messages with destination subnet ID equal to this destination ID will be forwarded to the next MPI/Profibus
Node (see next field)
Gateway Entry 1..3
Next MPI/Profibus Node ID
See previous row
Table 110: Advanced MPI/Profibus routing configuration parameter description
Default value
0 (disabled)
0000-0000
0000-0000
(invalid subnet ID)
0000-0000
2
0000-0000
2
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 146
5.12.2.3
Topic configuration
General Reference Guide IO Servers Configuration
Figure 109: Topic configuration
Three (3) topics can be used for the IO Server. These topics are used to give a common property to a group of MPI/ISOTCP Tags like:
• Enable/Disable
• Global Device Address
• Polling Rate
Topic configuration item
Topic enabled
Global Device Address
Poll rate
Description
Enables or disables polling of all the Tags in the topic.
See below for the Device Address Syntax. If an address is specified here, it will replace (overload) the address-defined Tag by Tag.
Defines the refresh rate of the Tag name. In a complex application, we can imagine that some Tag names must be refreshed every second - typically for digital input - and other every minute - typically: temperature-.
5.12.3
Tag name convention
IO Server Name
Topic Name
Item Name
B
C
S73&400
A
ValueName, Global Device Address
ValueName
PLC address is defined Tag by Tag
Topic PLC Address is used.
Table 111: S73&400 IO server - Tag name convention table
The Item Name can contain the PLC address where the value is polled, or not. If the address is also specified at the topic level, the address specified at Tag level will be ignored.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 147
General Reference Guide IO Servers Configuration
5.12.3.1
Value Name
The syntax is the following:
<Memory Type><Modifier><address>
Symbol
DBx
M
C
T
I
Q
PI
PQ
Memory Type
Data Block number x
Internal Memory
Counter
Timer
Discrete Inputs
Discrete Outputs
Peripheral Inputs
Peripheral Outputs
Table 112: S7 300-400 Memory types
Modifier
B, C, W, S, D, L, F
B, C, W, S, D, L, F
W, S
W, S
B, C, W, S, D, L, F
B, C, W, S, D, L, F
B, C, W, S, D, L, F
B, C, W, S, D, L, F
Important: All the addresses are always in BYTES (except for Counter and Timer that are objects)
Note: The Modifier can by omitted, the modifier in bold will be used (DB type must have a modifier).
Address
Byte offset
Byte offset
Object number
Object number
Byte offset
Byte offset
Byte offset
Byte offset
Symbol
D
L
F
W
S
B
C
Modifier value range
Byte signed Byte
Word signed Word
DWord signed DWord
Float
Table 113: S7 300-400 Modifiers
0 .. 255
-128 .. 127
0 .. 65535
-32768 .. 32767
0 .. 4294967296 (*)
-2147483648 .. 2147483647 (*)
+/- 3.4e38
Automatic
Tag type
DWord
Integer
DWord
Integer
DWord
Integer
Float
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
Examples address
MW4
CS1
DB2L5
IB3
I5#2 point to
the Word at address 4 (in bytes) in the Internal Memory the Counter number 1, read it as Signed Word the DWord at address 5 (in bytes) in the Data Block 2 the Byte at address 3 (in bytes) in the Discrete Inputs zone the bit 2 from the Byte (read ’Bit access modifer’ note below) at address 5 in the Discrete Inputs zone
Table 114: S7 300-400 register address examples
• Bit access modifier:
In any Memory Type (excluding Counter and Timer), it is possible to access a single bit.
A #x must be appended to the Value name.
As the address is always in byte, the Bit index goes only from 0 to 7, no Modifer are allowed (except B to separate DB block from the address).
The syntax can be used for reading bits and for writing them as well.
If Tag type “Automatic” is used, the type Boolean will be choosed.
Example:
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 148
General Reference Guide IO Servers Configuration
DB1B13#3 represents bit 3 of Byte 13 in DB 1
invalid: IW5#2 wrong because there is a Modifier
I5#10 wrong because bit number greater than 7
• Status register:
The STATUS Tag is a special Tag that returns information about the current state of the communication for a given device. As for other Tags, the status Tag ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each PLC used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 115: Tag Status meaning
5.12.3.2
Global Device Address
The device address is either appended to the ValueName in the Item Name definition or entered in the Topic global address fields.
The device address is composed like following:
MPI
node address: MPI node address of the PLC
MPI, MPI node address
Reach by MPI the PLC with the node address 2
node address: PROFIBUS node address of the PLC
PROFIBUS, Profibus node addr
Reach by Profibus the PLC with the node address 9
network indirectly connected to the eWON (behind one or several other
PLCs)
MPI, Subnet ID, node address
Subnet ID: ID of the destination S7-Subnet ID
node address: MPI/Profibus node address of the PLC to reach
Reach by MPI/Profibus the PLC with the node address 4 on the subnet with subnet ID 4859-4565
Table 116: MPI/ISOTCP device address syntax
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 149
General Reference Guide IO Servers Configuration
ISOTCP
IP address : IP address of the PLC (ex: 10.0.120.204)
Called TSAP : Transport Service Access Point (ex: 03.02)
ISOTCP, IP address, CalledTSAP
ISOTCP, IP address, CalledTSAP,
Subnet ID, MPI node address
Reach by ISOTCP the PLC at IP 10.0.120.204 with the TSAP 03.02
IP address : IP address of the PLC (ex: 10.0.120.204)
Called TSAP : Transport Service Access Point (ex: 03.02)
Subnet ID : ID of the MPI subnet
MPI node address : address of the PLC
Table 116: MPI/ISOTCP device address syntax
Important:
If the PLC address is defined at the Topic level, it can be omitted in the Tag definition. In that case the Tag name will only contain the "ValueName".
If the PLC address is specified at the Topic level, it will replace any address defined Tag by Tag.
note:
For an S7-300, it’s generally always 03.02 .
For an S7-400, you have to take into account the slot number of the CPU.
For example if the CPU is on slot 4 rack 0 use TSAP 03.04, if the CPU is on slot 5 rack 1 use TSAP 03,25.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 150
General Reference Guide IO Servers Configuration
5.13 S7-200 (PPI - ISOTCP)
5.13.1
Introduction
The S7200 IO Server is dedicated to communicate directly with SIEMENS PLC of family S7-200.
Since firmware 5.7, all eWON types, with serial port or with MPI port, are able to communicate in both PPI modes (MonoMaster and
MultiMaster).
Then, to communicate with a S7-200 device you could use either an eWON with a serial port or an eWON with an MPI port.
Usage eWON with SERIAL port
(EWxxx0x)
MonoMaster
eWON is the ONLY Master on the PPI network.
MultiMaster
eWON is not the only Master on the PPI network.
Other masters (HMI or PPI multimaster programming cables) may be present at the same time on the PPI bus.
Yes
Yes
(since firmware 5.7)
Table 117: PPI MonoMaster/MultiMaster usage
Usually, the eWON will be connected directly to the PLC’s PPI interface.
Since firmware 5.5, eWONs with an MPI port are able to communicate on a PPI MultiMaster bus.
Since firmware 5.7, eWONs with a serial port are able to communicate on a PPI MultiMaster bus.
eWON with MPI port
(EWxxx6x)
Yes
(since firmware 5.5)
Yes
(since firmware 5.5)
The eWON acts always as MASTER.
The standard serial port of eWON must be configure in RS-485 (with dipswitch) to communicate in PPI.
The ISOTCP (Ethernet) is available on all the eWON types.
5.13.2
Setup
5.13.2.1
Gateway configuration
Parameter
Destination PPI Address
Figure 110: Gateway parameters
Description
Identifies the PLC PPI Destination address when ISOTCP is used
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 151
5.13.2.2
COM configuration (serial port)
General Reference Guide IO Servers Configuration
Figure 111: PPI link configuration
Parameter
COM Port
Baud Rate
Parity
Databits
Stop bit(s)
HW mode
Reply Timeout
PPI Address
By default, eWON with Serial port will act as MonoMaster on the PPI link.
Description
Choose your COM port (only on eWON4002)
Speed of the PPI port. Available speeds are 9600, 19200 Bauds or disable
The parity to apply (None / Even /Odd)
Number of bits in data (7 or 8)
Number of Stop bits (1 or 2)
Choose the Hardware mode of communication: Half-Duplex by default or Full Duplex with/without hardware handshaking.
Maximum time the eWON will wait for a valid PPI message response
Device address of eWON on PPI link (0..126, default is 0)
5.13.2.2.1
Serial PPI MultiMaster configuration
To configure the serial port as PPI MultiMaster you need to configure the following parameters.
Figure 112: PPI Multimaster configuration parameters
Serial Multimaster
Parameter
StatusInterleave
NbrPollRetry
NbrGwRetry
HSA
Description
number of token messages sent by the eWON before one status request message is sent out.
Status messages are used to get the configuration of the network. In the case interleave number is high bandwith is used more efficiently for data exchange but network discovery and recovery is slow.
- default value: 0 (eWON is mono master no exchange of status or token pass messages)
- value range: 0..20
number of retrials for one user request (poll = ask for the response after reception of a positive ack from the PLC) before aborting the request. Usefull in case of high PLC load.
- default value: 15
- value range: 0..100 (0 means only one poll for one request) number of retrials for one gateway request (poll = ask for the response after reception of a positive ack from the PLC) before aborting the request. Usefull in case of bus confict due to high PLC load (reception of lot of nacks).
- default value: 15
- value range: 0..100
Highest station active
- default value: 31 value range: 15..127
Table 118: Serial PPI MultiMaster
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 152
5.13.2.3
COM configuration (MPI port)
General Reference Guide IO Servers Configuration
Figure 113: MPI link configuration
Parameter
Protocol Type
Baud Rate
Description
Select protocol PPI MULTIMASTER.
As the MPI port configuration is shared by the S7-200 and the S73&400
IOServers, this combo box shows also the MPI & Profibus protocols.
PPI MultiMaster and MPI/Profibus are mutually exclusive. It is not allowed to use at the same time the S7-200 and the S73&400 IOServers on the MPI port.
Speed of the MPI port.
Available speeds are:
• disable
• 9.6 kBauds
• 19.2 kBauds
• 45.45 kBauds
• 93.75 kBauds
• 187.5 kBauds
• 1.5 MBauds
• 3
MBauds (only for 2005CD-MPI or 4005CD-MPI)
• 6
• 12
MBauds (only for 2005CD-MPI or 4005CD-MPI)
MBauds (only for 2005CD-MPI or 4005CD-MPI)
Reply Timeout
PPI MultiMaster Address
The maximum time the eWON will wait for a valid MPI message response
The device address of eWON on PPI link (0..126, default is 0)
PPI Highest Station Address
The highest station address polled by eWON. Select between 15, 31, 63 or
127.
Figure 114: PPI MultiMaster settings
Note: When using the PPI MultiMaster, the status counters to be checked are the MPI counters and not the PPI counters.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 153
5.13.2.4
Topic configuration
General Reference Guide IO Servers Configuration
Figure 115: Topic configuration
Three (3) topics can be used for the IO Server. These topics are used to give a common property to a group of PPI/ISOTCP Tags like:
• Enable/Disable
• Global Device Address
• Polling Rate
Topic configuration item
Topic enabled
Global Device Address
Poll rate
Description
Enables or disables polling of all the Tags in the topic.
See below for the Device Address Syntax. If an address is specified here, it will replace (overload) the address-defined Tag by Tag.
Defines the refresh rate of the Tag name. In a complex application, we can imagine that some Tag names must be refreshed every second - typically for digital input - and other every minute - typically: temperature-.
5.13.3
Tag name convention
IO Server Name
Topic Name
Item Name
B
C
S7200
A
ValueName, Global Device Address
ValueName
PLC address is defined Tag by Tag
Topic PLC Address is used.
Table 119: S7200 IO server - Tag name convention table
The Item Name can contain the PLC address where the value is polled, or not. If the address is also specified at topic level, the address specified at Tag level will be ignored.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 154
General Reference Guide IO Servers Configuration
5.13.3.1
Value Name
The syntax is the following:
<Memory Type><Modifier><address>
AQ
I
Q
HC
T
AI
Symbol
M
SM
V
C
Memory Type
Internal Memory
Special Memory
Variable Memory
Counter
High-Speed Counter
Timer
Analog Inputs
Analog Outputs
Discretes Inputs
Discretes Outputs
Modifier allowed
B, C, W, S, D, L, F
B, C, W, S, D, L, F
B, C, W, S, D, L, F
W, S
D, L
D, L
W, S
W, S
B, C, W, S, D, L, F
B, C, W, S, D, L, F
Address
Byte offset
Byte offset
Byte offset
Object number
Object number
Object number
Byte offset
Byte offset
Byte offset
Byte offset
Table 120: S7200 Memory types and address scheme
Important: All addresses are always in BYTES (except for Counters and Timer that are objects).
Note: The Modifier can be omitted, the modifier in bold will be used.
Symbol
B
C
W
S
D
L
Modifier
Byte signed Byte
Word signed Word
DWord signed DWord
value range
0 .. 255
-128 .. 127
0 .. 65535
-32768 .. 32767
0 .. 4294967296 (*)
-2147483648 .. 2147483647 (*)
Automatic
Tag type
DWord
Integer
DWord
Integer
DWord
Integer
F
Float +/- 3.4e38
Float
Table 121: S7200 Modifiers
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
Examples
address
MW4
HCL1
AQW5
IB3
I5#2 point to
the Word at address 4 (in bytes) in the Internal Memory the HighSpeed Counter number 1 and read it in Signed DWord the Word at address 5 (in bytes) in the Analog Output zone the Byte at address 3 (in bytes) in the Discrete Inputs zone the bit 2 from the Byte (read the ’Bit access modifier’ note below) at address 5
(in bytes) in the Discrete Inputs zone
Table 122: S7 200 register address examples
• Bit access modifier:
For Memory Type M, SM, V, I and Q, it is possible to access a single bit.
A #x must be appended to the Value name.
As the address in always in byte, the Bit index goes only from 0 to 7, and no Modifers are allowed.
The syntax can be used for reading bits and for writing them as well.
If Tag type “Automatic” is used, the type Boolean will be choosed.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 155
General Reference Guide IO Servers Configuration
Example:
AQ10#5 represents bit 5 of Byte 10 in Analog Output zone.
invalid:IW5#2 wrong because there is a Modifier
I5#10 wrong because bit number greater than 7
• Status register:
The STATUS Tag is a special Tag that returns information about the current state of communication for a given device. As for the other Tags, the status Tag ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each PLC used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 123: Tag Status meaning
5.13.3.2
Global Device Address
The device address is either appended to the ValueName in the Item Name definition or entered in the Topic global address fields.
The device address is composed like the following:
PPI
node address: PPI node address of the PLC
PPI, PPI node address
Reach by PPI the PLC with the node address 4
ISOTCP
IP address : IP address of the PLC (ex: 10.0.120.204)
Called TSAP : Transport Service Access Point (ex: 4D.57)
ISOTCP, IP address, CalledTSAP
Reach by ISOTCP the PLC at IP 10.0.120.204 with the TSAP 4D.57
Table 124: PPI/ISOTCP device address syntax
5.13.3.2.1
ISOTCP polling:
You can always use the TSAP 4D.57. This is the default TSAP for a Step 7-Micro/win connection.
If you specify your own connection in the S7-200, be sure to:
- use the same TSAP for the Server and the Client (ex: Local TSAP:12.00, Remote TSAP:12.00)
- Check the "Enable the Keep Alive function for this connection" feature for this connection otherwhise the eWON will not be able to poll the device after a connection lost due to the eWON reboot.
Important:
If the PLC address is defined at the Topic level, it can be omitted in the Tag definition. In that case the Tag name will only contain the "ValueName".
If the PLC address is specified at the Topic level, it will replace any address defined Tag by Tag.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 156
General Reference Guide IO Servers Configuration
5.14 HITACHI IO Server
5.14.1
Introduction
The Hitachi IOServer allows the eWON to poll tags belonging to a HITACHI EH series PLC using its serial link or Ethernet interface.
eWON uses standard H protocol (for serial RS232), station number H protocol (for serial RS485), and Ethernet H-protocol (for Ethernet).
No remote maintenance functionality is provided by this IO server.
5.14.1.1
Setup
5.14.1.1.1
COM configuration
Figure 116: HITACHI IOServer: COM setup
Parameter
Baud Rate
Parity
Databits
Stop bit(s)
HW mode
Reply Timeout
Description
Speed of the Serial port.
Available speeds are 1200, 2400, 4800, 9600, 19200 Bauds or disabled
The parity to apply (None / Even / Odd)
The number of bits in data (7 or 8)
The number of Stop bits (1 or 2)
Choose the Hardware mode of communication:
• Ful Duplex HW handshaking (by default)
• Full Duplex NO handshaking
• Half duplex
Maximum time the eWON will wait for a valid message response
Table 125: HITACHI IOServer: COM parameters
The eWON implements Transmission Control Procedure 1 (One way activation Control Procedure).
When half-duplex mode is used (RS485), the eWON acts as master. So, no other master may be on the bus (eg: control panel or host).
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 157
5.14.1.1.2
Topic configuration
General Reference Guide IO Servers Configuration
Figure 117: HITACHI IOServer: Topic configuration
Three (3) topics can be used for the IO Server. These topics are used to give a common property to a group of Hitachi Tags like:
• Enable/Disable
• Global Device Address
• Polling Rate
Topic configuration item
Topic enabled
Global Device Address
Poll rate
Description
Enables or disables polling of all the Tags in the topic.
See below for the Device Address Syntax. If an address is specified here, it will replace (overload) the address-defined Tag by Tag.
Defines the refresh rate of the Tag name. In a complex application, we can imagine that some Tag names must be refreshed every second - typically for digital input - and other every minute - typically: temperature-.
Table 126: HITACHI IOServer: Topic configuration item definition
5.14.2
Tag name convention
IO Server Name
Topic Name
Item Name
B
C
HITACHI
A
ValueName, Global Device Address
ValueName
PLC address is defined Tag by Tag
Topic PLC Address is used.
Table 127: HITACHI IOserver - Tag name convention table
The Item Name can contain the PLC address where the value is polled or not. If an address is also specified at topic level, the address specified at Tag level will be ignored.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 158
General Reference Guide IO Servers Configuration
5.14.2.1
Value Name
The syntax is the following:
<Memory Type>[<Modifier>]<address>
Symbol
X
WX
DX
Y
WY
DY
R
WR
DR
M
WM
DM
Memory type
Modifier allowed
(optional)
Address
External Input Bit
External Input Word
External Input Double
External Output Bit
External Output Word
External Output Double
Internal Output Bit dedicated
Internal Output Word dedicated
Internal Output Word dedicated
Double
Internal Bit Output Common
Internal Word Output Common
Internal Word Output Common
Double
W, S
D, L, F
W, S
D, L, F
W, S
D, L, F
W, S
D, L, F
Hrusbb
H stands for hexadecimal r: remote number (1 digit hexadecimal) u: unit number (1digit hexadecimal) s: slot number (1 digit hexadecimal) bb: bit offset (00 ..FF 2 digits hexadecimal)
Hrusw
H stands for hexadecimal r: remote number (1 digit hexadecimal) u: unit number (1digit hexadecimal) s: slot number (1 digit hexadecimal) w: word offset (1digit hexadecimal)
Hrusw
H stands for hexadecimal r: remote number (1 digit hexadecimal) u: unit number (1digit hexadecimal) s: slot number (1 digit hexadecimal) w: word offset (1digit hexadecimal)
Hrusbb
H stands for hexadecimal r: remote number (1 digit hexadecimal) u: unit number (1 digit hexadecimal) s: slot number (1 digit hexadecimal) bb: bit offset (00..FF: 2 digits hexadecimal)
Hrusw
H stands for hexadecimal r: remote number (1 digit hexadecimal) u: unit number (1digit hexadecimal) s: slot number (1 digit hexadecimal) w: word offset (1digit hexadecimal)
Hrusw
H stands for hexadecimal r: remote number (1 digit hexadecimal) u: unit number (1digit hexadecimal) s: slot number (1 digit hexadecimal) w: word offset (1digit hexadecimal)
Hxxxxxx
H stands for hexadecimal x: 1 to 6 digits hexadecimal indicating bit offset
Hxxxxxx
H stands for hexadecimal x: 1 to 6 digits hexadecimal indicating word offset
Hxxxxxx
H stands for hexadecimal x: 1 to 6 digits hexadecimal indicating word offset
Hxxxxxx
H stands for hexadecimal x: 1 to 6 digits hexadecimal indicating bit offset
Hxxxxxx
H stands for hexadecimal x: 1 to 6 digits hexadecimal indicating word offset
Hxxxxxx
H stands for hexadecimal x: 1 to 6 digits hexadecimal indicating word offset
Table 128: HITACHI Memory types and address scheme
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 159
General Reference Guide IO Servers Configuration
L
WL
DL
CPU Link Bit
CPU Link Word
CPU Link Double
W, S
D, L, F
Hxxxxxx
H stands for hexadecimal x: 1 to 6 digits hexadecimal indicating bit offset
Hxxxxxx
H stands for hexadecimal x: 1 to 6 digits hexadecimal indicating word offset
Hxxxxxx
H stands for hexadecimal x: 1 to 6 digits hexadecimal indicating word offset
Table 128: HITACHI Memory types and address scheme
Note: The Modifier can by omitted, the modifier in bold will be used.
Symbol
D
L
F
W
S
Modifier
Word signed Word
DWord signed DWord
Float
value range
0 .. 65535
-32768 .. 32767
0 .. 4294967296 (*)
-2147483648 .. 2147483647 (*)
+/- 3.4e38
Automatic
Tag type
DWord
Integer
DWord
Integer
Float
Table 129: HITACHI Modifiers
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
Examples
address
XH00103
WYH0011
RH105
WRSH10
WMH10
DMH10
WMH000010 point to
selection of bit3 of word 0 of the input device located at remote:0 unit:0 slot:1 selection of word 0 of the output device located at at remote:0 unit:0 slot 1 bit 105 hex (261 decimal) of the Internal Output Bit Dedicated area short located at word 10 hex of the WR area word 10 hex of the Internal Word Output Common area double word 10 + 11 hex of the Internal Word Output Common area word 10 hex of the Internal Word Output Common area
(WMH10 is more optimal)
Table 130: HITACHI register address examples
• Status register:
The STATUS Tag is a special Tag that returns information about the current state of communication for a given device. As for the other Tags, the status Tag ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each PLC used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 131: Tag Status meaning
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 160
General Reference Guide IO Servers Configuration
5.14.2.2
Global Device Address
The device address is either appended to the ValueName in the Item Name definition, or entered in the Topic global address fields.
The device address syntax is the following:
EH[,[[ipaddress,TCP|UDP,port]|[station]][,LUMP]]
EH,station
EH
EH,station,LUMP
EH,LUMP
EH,ipaddress,TCP|UDP,port
EH,ipaddress,TCP|UDP,port,LUMP
EH Serial
station : address of the PLC on the network
EH,4 the eWON will access PLC number 4.
By configuration, an HITACHI PLC could have an undefined station number.
If this PLC is alone on a serial link, you don’t need to specify a station number.
station : address of the PLC on the network
LUMP : Link Unit Port Module
EH,4,FFFF0000 the eWON will access PLC number 4 with the LUMP FFFF0000.
By configuration, an HITACHI PLC could have an undefined station number.
If this PLC is alone on a serial link, you don’t need to specify a station number.
LUMP : Link Unit Port Module
EH,FFFF0000 the eWON will access PLC with the LUMP FFFF0000.
EH ethernet
ipaddress : IP address of the PLC
TCP|UDP : select the protocol used
port : IP port used
EH,10.0.120.203,TCP,3004 the eWON will access the PLC at 10.0.120.203 with protocol
TCP and port 3004
ipaddress : IP address of the PLC
TCP|UDP : select the protocol used
port : IP port used
LUMP : Link Unit Port Module
EH,10.0.120.203,TCP,3004,FFFF0000 the eWON will access the PLC at 10.0.120.203, protocol TCP, port 3004 and LUMP FFFF0000
Table 132: HITACHI device address syntax
Important:
If the PLC address is defined at the Topic level, it can be omitted in the Tag definition. In that case the Tag name will only contain the "ValueName".
If the PLC address is specified at the Topic level, it will replace any address defined Tag by Tag.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 161
General Reference Guide IO Servers Configuration
5.15 MITSUBISHI FX IO Server
5.15.1
Introduction
This MITSUFX IOServer allows the eWON to poll tags belonging to a MITSUBISHI FX series PLC using its RS-422 base unit programming connector. No remote maintenance functionality is provided by this IO server. The VCOM feature of the eWON has to be used to cover a remote maintenance.
MITSUFX IOServer is available in eWON with Firmware 5.5 and above.
5.15.2
Setup
5.15.2.1
COM configuration
Figure 118: MITSUFX IOServer: COM setup
Parameter
Baud Rate
Parity
Databits
Stop bit(s)
HW mode
Reply Timeout
Description
Speed of the Serial port.
Available speeds are from 9600 until 115200 Bps or disabled
The parity to apply (None / Even / Odd)
The number of bits in data (7 or 8)
The number of Stop bits (1 or 2)
Choose the Hardware mode of communication:
• Ful Duplex HW handshaking
• Full Duplex NO handshaking (by default)
• Half duplex
The maximum time the eWON will wait for a valid message response
Table 133: MITSUFX IOServer: COM parameters
The switches of the eWON must be configured in RS485/RS422 mode.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 162
5.15.2.2
Topic configuration
General Reference Guide IO Servers Configuration
Figure 119: MITSUFX IOServer: Topic configuration
Three (3) topics can be used for the IO Server. These topics are used to give a common property to a group of Mitsubishi Tags like:
• Enable/Disable
• Global Device Address
• Polling Rate
Topic configuration item
Topic enabled
Global Device Address
Poll rate
Description
Enables or disables polling of all the Tags in the topic.
Select the type of Mitsubishi PLC to link. Available FX type are:
• FX
• FX0
• FX0N
• FX2N
• FX3U
There is no address (number) to add because the eWON is connected directly to one PLC by its programming port.
If a device is specified here, it will replace (overload) the device-defined Tag by
Tag.
Defines the refresh rate of the Tag name. In a complex application, we can imagine that some Tag names must be refreshed every second - typically for digital input - and other every minute - typically: temperature-.
Table 134: MITSUFX IOServer: Topic configuration item definition
5.15.3
Tag name convention
IO Server Name
Topic Name
Item Name
B
C
MITSUFX
A
ValueName, Global Device Address
ValueName
PLC address is defined Tag by Tag
Topic PLC Address is used.
Table 135: MITSUFX IOserver - Tag name convention table
The Item Name can contain the PLC address where the value is polled, or not. If the address is also specified at topic level, the address specified at Tag level will be ignored.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 163
General Reference Guide IO Servers Configuration
5.15.3.1
Value Name
The syntax is the following:
<Memory Type Symbol>[<Modifier>]<address>
Symbol Memory type
Modifier allowed
(optional)
Address
X
Y
M
M
C
D
D
CR
T
C
S
TC
CC
TR
Input Bit (boolean)
Output Bits (boolean)
Auxiliary relays (boolean)
Special Auxiliary relays
(boolean)
States (boolean)
Timer Contacts (boolean)
Counter Contacts (boolean)
Timer Reset (boolean)
Counter Reset (boolean)
Timer Value
Counter Value
High Speed Counter Value
Data Registers
Special Data Registers
W, S
W, S
L, D
S, W, L, D, F
S, W, L, D, F
1 to 3 OCTAL digits
1 to 3 OCTAL digits
1 to 4 decimal digits (max 7999)
1 to 4 decimal digits (min 8000)
1 to 4 decimal digits
1 to 3 decimal digits
1 to 3 decimal digits
1 to 3 decimal digits
1 to 3 decimal digits
1 to 3 decimal digits
1 to 3 decimal digits (max 199)
1 to 3 decimal digits (min 200)
1 to 4 decimal digits (max 7999)
1 to 4 decimal digits (min 8000)
Table 136: MITSUFX Memory types and address scheme
Note: The Modifier can be omitted, the modifier in bold will be used.
Symbol
D
L
F
W
S
Modifier
Word signed Word
DWord signed DWord
Float
value range
0 .. 65535
-32768 .. 32767
0 .. 4294967296 (*)
-2147483648 .. 2147483647 (*)
+/- 3.4e38
Automatic
Tag type
DWord
Integer
DWord
Integer
Float
Table 137: MITSUFX Modifiers
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
Examples
address
X14
D3
DD3
DF3
D8010
C199
C200 point to
input bit at octal address 14 data register at address 3 (read as Signed Word) data register at address 3 (read as DWord) data register at address 3 (read as Float) special data register at address 8010 (read as Signed Word) counter value at address 199 (read as Word) high speed counter at address 200 (read as DWord)
Table 138: MITSUFX register address examples
• Status register:
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 164
General Reference Guide IO Servers Configuration
The STATUS Tag is a special Tag that returns information about the current state of communication for a given device. As for the other Tags, the status Tag ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each PLC used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 139: Tag Status meaning
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 165
General Reference Guide IO Servers Configuration
5.16 SNMP IO Server
5.16.1
Introduction
The SNMP IO server (Simple Network Management Protocol) is used to communicate with any SNMPv1 device on the network. It allows both read and write operations on 32-bit objects. It supports access to several different devices at the same time.
The following object types are supported: INTEGER, 32bits COUNTER, GAUGE, UNSIGNED, TIMETICK and extracted FLOAT (see §
Name” on page 167 ). There is no handling of MIB files.
SNMP IOServer is available in eWON with Firmware 5.6s2 and above.
5.16.2
Setup
Figure 120: SNMP IOServer: setup
Three (3) topics can be used for the IO Server. These topics are used to give a common property to a group of SNMP Tags like:
• Enable/Disable
• Global Device Address
• Polling Rate
Topic configuration item
Topic enabled
Global Device Address
Poll rate
Description
Enables or disables polling of all the Tags in the topic.
Select the target SNMP Server device.
Syntax:
• IP_Addr,Read_Community,Write_community
IP_Addr: IP address of the SNMP Server
Read_Community: Community used for Reading
Write_Community: Community used for Writing
• IP_Addr,Community
IP_Addr: IP address of the SNMP Server
Community: Community used for Reading and Writing
If an address is specified here, it will replace (overload) the address-defined Tag by Tag.
Defines the refresh rate of the Tag name. In a complex application, we can imagine that some Tag names must be refreshed every second - typically for digital input - and other every minute - typically: temperature-.
Table 140: SNMP IOServer: Topic configuration item definition
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 166
General Reference Guide IO Servers Configuration
5.16.3
Tag name convention
IO Server Name
Topic Name
Item Name
B
C
SNMP
A
ValueName, Global Device Address
ValueName
PLC address is defined Tag by Tag
Topic PLC Address is used.
Table 141: SNMP IOserver - Tag name convention table
The Item Name can contain the Device address where the value is polled, or not. If the address is also specified at topic level, the address specified at Tag level will be ignored.
5.16.3.1
Value Name
As the SNMP use an Abstract Syntax Notation (ASN), encode the full OID (Object ID) of the data you want to Read/Write.
You cannot import MIB files into the eWON.
INTEGER, 32bits COUNTER, GAUGE, UNSIGNED, TIMETICK and extracted FLOAT (see Note below) are supported
For all integer objects (not for the extracted FLOAT), use the Integer type to save them. Choosing the Automatic type will use the
(*) Note: Since firmware 6.4s4 the SNMP IOServer can read STRING-type OID and converts them in FLOAT. If, for example, a tag contains the
string [AnyText 6.78], the extracted result will be [6.78] while eWON converts it by keeping only the number part of the string. As FLOAT does not
exist in SNMP, this is a work around to this limitation. This works in read only, not in write.
Examples
address
.1.3.6.1.2.1.4.3.0
.1.3.6.1.2.1.4.3.0,10.0.0.55,public,private point to
read the .iso.org.dod.internet.mgmt.mib-2.ip.ipInReceives object read the .iso.org.dod.internet.mgmt.mib-2.ip.ipInReceives object at the IP
10.0.0.55 using community "public" for reading and the community "private" for writing.
Table 142: SNMP address examples
IMPORTANT:
The address of SCALAR objects ends with a 0 while the address of array items ends with their index in the array (starting from 1).
For example, to read .iso.org.dod.internet.mgmt.mib-2.ip.ipInReceives that have the address ".1.3.6.1.2.1.4.3", you must add a ".0" at the end to obtain ".1.3.6.1.2.1.4.3.0".
And to read .iso.org.dod.internet.mgmt.mib-2.interfaces.ifTable.ifEntry.ifMtu (".1.3.6.1.2.1.2.2.1.4") of the second interface, because this object is a table, you must add ".2" at the end to obtain ".1.3.6.1.2.1.2.2.1.4.2".
NOTE: We recommend you to check the SNMP address with an SNMP Client (like Getif http://www.wtcs.org/snmp4tpc/getif.htm
) to find the right address.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 167
General Reference Guide IO Servers Configuration
Example: Searching in the MIB file of a network printer to find the address of the "TotalNumberOfPagePrinted", we found :
.iso.org.dod.internet.mgmt.mib-2.printmib.prtMarker.prtMarkerTable.prtMarkerEntry.prtMarkerLifeCount at address ".1.3.6.1.2.1.43.10.2.1.4"
Using the MIB file with Getif to retrieve the whole address of this Counter, we see that the Counter is in a 2 dimension table and we need to add ".1.1" to get its value.
• Status register:
The STATUS Tag is a special Tag that returns information about the current state of communication for a given device. As for the other Tags, the status Tag
ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each
Device used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 143: Tag Status meaning
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 168
General Reference Guide IO Servers Configuration
5.17 MITSUBISHI MELSEC IO Server
5.17.1
Introduction
This MELSEC IOServer allows the eWON to poll tags belonging to the MITSUBISHI Q-Series PLC using the protocol on the Ethernet interface.
To cover remote maintenance for the Mitsubishi PLCs, the Ethernet routing feature or VCOM feature (serial) of the eWON have to be used.
The MELSEC IOServer is available from firmware version 6.3 onwards.
Since firmware 7.0 eWON also integrates the E1 frames of the MC protocol to allow polling the FX3U and A-Series PLC’s through their Ethernet interface
5.17.2
Setup
5.17.2.1
Topic configuration
Figure 121: MELSEC IOServer: Topic configuration
Three (3) topics can be used for the IO Server. These topics are used to give a common property to a group of Mitsubishi Tags like:
• Enable/Disable
• Global Device Address
• Polling Rate
Topic configuration item
Topic enabled
Global Device Address
Q-Series
QCPU,QnACPU & QOCPU
Description
Enables or disables polling of all the Tags in the topic.
Syntax:
Model,Protocol,IP Address,Port Number,Network Number,PC Number
[,ReqDestModuleIONo,ReqDestModuleStationNo], where:
• Model: QCPU,QnACPU or QOCPU
• Protocol: TCP, UDP
• IP Address: is the IP address of the PLC
• Port Number: is the Port of the PLC on which it is listening for MC protocol
• Network Number: network number of the target (1..239) (0)
• PC Number: Target Station Number (1..64) (FF)
• Optional ReqDestModulelONo default FF 03
• Optional ReqDestModuleStationNo default 0
Example: QCPU,UDP,198.162.120.155,5000,1,1
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 169
General Reference Guide IO Servers Configuration
Global Device Address
A-Series
ACPU
Global Device Address
FX-Series
FX3UCPU
Poll rate
Syntax:
Model,Protocol,IP Address,Port Number,PC Number where:
• Model: ACPU
• Protocol: TCP, UDP
• IP Address: is the IP address of the PLC
• Port Number: is the Port of the PLC on which it is listening for MC protocol
• Network Number: network number of the target (1..239) (0)
Example: ACPU,UDP,198.162.120.155,5000,1
Syntax:
Model,Protocol,IP Address,Port Number where:
• Model: FX3UCPU
• Protocol: TCP, UDP
• IP Address: is the IP address of the PLC
• Port Number: is the Port of the PLC on which it is listening for MC protocol
Example: FX3UCPU,UDP,198.162.120.155,5000
Defines the refresh rate of the Tag name. In a complex application, we can imagine that some Tag names must be refreshed every second - typically for digital input - and other every minute - typically: temperature-.
Table 144: MELSEC IOServer: Topic configuration item definition
Temporary hidden table
Examples of Global Device Address syntax
CPU
Q
Q
Protoco l
TCP
UDP
IP Address
192.168.140.10
192.168.140.10
Port #
5000
5000
QNA
QNA
QO
QO
TCP
UDP
TCP
UDP
192.168.140.10
192.168.140.10
192.168.140.10
192.168.140.10
5000
5000
5000
5000
A
A
FX3U
FX3U
TCP
UDP
TCP
UDP
192.168.1.70
192.168.1.70
192.168.140.10
192.168.140.10
1284
1284
5001
5002
Network ID of PLC
1
1
1
1
1
1
None
None
None
None
Network ID of PC
5
5
5
5
5
5
255
255
None
None
IOServer settings
QCPU, TCP,192.168.140.10, 5000,1,5
QCPU, UDP,192.168.140.10, 5000,1,5
QNACPU, TCP,192.168.140.10, 5000,1,5
QNACPU, UDP,192.168.140.10, 5000,1,5
QOCPU, TCP,192.168.140.10, 5000,1,5
QOCPU, UDP,192.168.140.10, 5000,1,5
ACPU, TCP,192.168.1.70, 1284, 255
ACPU, UDP,192.168.1.70, 1284, 255
FX3UCPU, TCP,192.168.140.10, 5001,1,5
FX3UCPU, UDP,192.168.140.10, 5002,1,5
5.17.3
Tag name convention
IO Server Name
Topic Name
Item Name
B
C
MELSEC
A
ValueName, Global Device Address
ValueName
PLC address is defined Tag by Tag
Topic PLC Address is used.
Table 145: MITSUFX IOserver - Tag name convention table
The Item Name can contain the PLC address where the value is polled, or not. If the address is also specified at topic level, the address specified at Tag level will be ignored.
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 170
General Reference Guide IO Servers Configuration
5.17.3.1
Value Name
The syntax is the following:
<Memory Type Symbol>[<Modifier>]<address>
Symbol Memory type
Modifier allowed
(optional)
Address
SW
R
Z
D
SD
W
CS
CC
CN
SS
SC
SN
TS
TC
TN
F
V
S
M
SM
L
DY
B
SB
X
DX
Y
Input
Direct Input
Output
Direct Output
Link Relay
Special Link Relay
Internal Relay
Special Internal Relay
Latch Relay
Annunciator Relay
Edge Relay
Step relay
Timer Contact
Timer Coil
Timer Value
Integrating Timer Contact
Integrating Timer Coil
IntegratingTimer Value
Counter Contact
Counter Coil
Counter Value
Data Register
Special Data Register
Link Register
Special Link Register
File Register
Index Register
W, S
W, S
W, S
S, W, L, D, F
S, W, L, D, F
S, W, L, D, F
S, W, L, D, F
S, W, L, D, F
S, W, L, D, F
1 to 6 hexadecimal bits
1 to 6 hexadecimal bits
1 to 6 hexadecimal bits
1 to 6 hexadecimal bits
1 to 6 hexadecimal bits
1 to 6 hexadecimal bits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
1 to 6 decimal digits
Table 146: MELSEC Memory types and address scheme
Note: The Modifier can be omitted, the modifier in bold will be used.
Symbol
W
S
D
L
Modifier
Word signed Word
DWord signed DWord
value range
0 .. 65535
-32768 .. 32767
0 .. 4294967296 (*)
-2147483648 .. 2147483647 (*)
Automatic
Tag type
DWord
Integer
DWord
Integer
F
Float +/- 3.4e38
Float
Table 147: MELSEC Modifiers
(*) Important: To avoid loss of precision due to Integer to float conversion, choose the right storage DataType for your Tag.
See "DataType of Tags" on page 79
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 171
General Reference Guide IO Servers Configuration
Examples
address
X14
D3
DD3
DF3
D8010 point to
input bit at octal address 14 data register at address 3 (read as Signed Word) data register at address 3 (read as DWord) data register at address 3 (read as Float) special data register at address 8010 (read as Signed Word)
Table 148: MELSEC register address examples
• Status register:
The STATUS Tag is a special Tag that returns information about the current state of communication for a given device. As for the other Tags, the status Tag ValueName is composed of:
Status, Global Device Address
• You can define a status Tag for each PLC used.
• If you use the status address, the Tag must be configured as analog.
0
1
2
Communication not initialized. Status UNKNOWN.
If no Tag is polled on that device address, the communication status is unknown.
Communication OK.
Communication NOT OK.
Table 149: Tag Status meaning
RG-001-1-EN rev. 2.1
eWON® - 10/12/2013 - ©eWON sa Page 172
General Reference Guide
6 eWON Monitoring Web Interface
Monitoring Web Interface
If you have configured the eWON with some Tag names, you can now come back to the eWON’s Web Interface menu (Main Menu). The Web
Interface menu of the eWON looks like this:
Figure 122: eWON Web Interface menu
The little home icon under the eWON logo can be accessed from any page of the eWON Scada and will always lead your browser directly to this main menu of the Web Interface.
You can always click on the eWON logo to obtain the definition and system information about the eWON you are connected to. A second navigator window will be opened giving you a summary of the main information about the current eWON:
Figure 123: eWON information page
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 173
General Reference Guide Monitoring Web Interface
6.1 Real-time screen
Click on the View IO item from the eWON Web Interface menu to obtain the list of all eWON Tag names and associated real-time values. To refresh the value, click again on View IO item.
Figure 124: eWON real time screen
6.1.1
Change a Tag value
As shown in the above example, in the first row from the Tag list, if the Tag name is an output and if the user has the right to ’force output’, an edit box and an Update link are available. To change the value of the output just fill the related edit box with the new wanted value and click on the related Update link.
If the Tag is of Boolean type, a combo box with values 0 (zero) and 1 is then displayed.
6.1.2
Tag quality
Since the firmware 6.0, eWON Tags have a Quality Information. This quality gives indications about how reliable and recent the displayed value actually is.
Figure 125: Tag Quality
When a tag is qualified as “bad”, the Tag value is displayed in red and a red square is displayed before the value.
Placing the mouse cursor on this red square (no need to click) and an information about the quality problem will be displayed (here above, “No communication”).
You can find complete reference of TagQuality in the document “KB-0039-0-EN-(Tag Quality).pdf” on the support website (http:// support.ewon.biz).
6.1.3
Alarm state
If the Tag name is in alarm state, a yellow bell appears at its left side:
You can click on this picture to access directly the Alarm summary screen.
Tag description: The description of the Tag is also displayed for each Tag.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 174
General Reference Guide Monitoring Web Interface
6.1.4
Real time graph
If a real time recording is enabled for a Tag, a small icon will appear next to its name:
This small icon is an hyperlink to show the graph picture. When the link is clicked, another window will open and after a small delay (about 3 seconds), a graph will be displayed:
This graph displays the whole real time window.
Important: If the main explorer window hides the real time window, clicking again on the real time graph hyperlink will not bring it forward. You should bring it forward manually.
6.1.5
Historical window
A check box may also appear in the first column of the View I/O screen meaning that you can choose this Tag to view its historical trend. It
6.2 Historical Trending screen
Warning: depending on the eWON's version - c.f. table at the end of this manual.
From the real time screen, users can select Tags (providing that the historical logging has been enabled for those Tags) by clicking on the related checkbox and request a graph for these Tags by clicking on the Show Graph for selection link above the real time tabs. Up to 4 Tags can be selected at the same time to be plotted on the graph.
Figure 126: eWON historical trend configuration - 1
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 175
General Reference Guide Monitoring Web Interface
The user has then to select the correct time range for the Tag's selection and click on the Update graph link to obtain a historical trend. The common axis checkbox allows visualizing all the Tag names on the same axis. If the scales are different, it is clearer to display each curve with its own scale (by unchecking the Common Axis checkbox).
Figure 127: eWON historical trend configuration - 2
Figure 128: eWON historical trend graph
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 176
General Reference Guide Monitoring Web Interface
6.3 Historical table
The historical table is a representation of the IRCALL.BIN (incremental recording).
This representation provides recordings representation as a table where columns are Tag names and rows are recording times.
The features can be used at 2 levels:
• A page in the VIEW area.
• An export bloc descriptor exists (see “$dtHT [Historical Table]” on page 201).
The Historical table is available through the View I/O page.
Figure 129: eWON Historical Table link
Use the Historical Logging Table link to access to the following page.
Figure 130: eWON Historical Table parameters
These fields only accept date on the DD/MM/YYYY HH:MM:SS format. If the hour, minutes, seconds parameter are missing, they will be set to 0.
You can filter the Tags shown by selecting the Instant Value Groups (combination of A,B,C,D groups).
If you want to display all the Tags (with historical logging) of the eWON, check the Any checkbox.
The Include tags with HL disabled checkbox allows you to include Tags with Historical logging currently disabled but having been previously recorded in the file.
The Interval parameter allow you to specify a fixed interval, in seconds, to generate the table (each row will be evenly distributed in time). The Tag value placed in the row is the latest logged value.
If the Interval is empty or set to 0, the output time is defined by the time in the recording file. You will have a row at each value changes (as shown in the figure below).
Figure 131: eWON Historical Table
You can use the link Download as text file to export this table in csv format.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 177
6.4 Real time Alarm screen
General Reference Guide Monitoring Web Interface
Figure 132: eWON real time alarm screen
The real time alarm page lists all the Tag names currently in alarm state.
• The ’Date’ tab displays the eWON date and hour when the Tag was in alarm.
• The ’Name’ tab displays the Tag in alarm.
• The ’Action/Date’ tab displays the last status of the Tag and the date and hour of this state.
• The ’User Ack’ tab displays the user who acknowledged the alarm.
• The ’Description’ tab displays the description of the Tag in alarm.
There are several types of Alarm status:
ALM (HI)
ALM (HIHI)
ALM (LO)
ALM (LOLO)
ALM
RTN
ACK
ALARM status, the current value is in warning high position
ALARM status, the current value is in insecure high position
ALARM status, the current value is in warning low position
ALARM status, the current value is in insecure low position
ALARM status, the present value is out of defined threshold (Boolean Tag)
Return to Normal status, the present value is inside the defined threshold but has been out of threshold before and hasn’t be acknowledged
Acknowledgment status, the present value is out of defined threshold but someone has acknowledged the alarm
Table 150: alarm status types
It is possible to define an alarm hint (“Tag main edit window” on page 82):
Figure 133: eWON alarm notification: pre-defined hint
This alarm hint can be useful to help the users that are allowed to take actions regarding the alarms.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 178
General Reference Guide Monitoring Web Interface
6.5 Historical Alarm screen
The historical alarm screen is used to find the alarms generated in the past and know who acknowledged a specified alarm. All the alarms are stacked from the top to the bottom.
The given information is:
• The date and the hour of the event.
• The Tag name.
• The type of the event: ALM, RTN, ACK or END (RTN and ACK).
• The user who acknowledged the alarm.
• The description of the Tag.
Figure 134: eWON alarm history page
The Previous Page link is used to go back to the past and the Next page link is used to go to the present. When no more alarm is available for display, the following message appears: "No more history page".
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 179
General Reference Guide
6.6 Files transfer
This link gives you access to a page where the eWON files are listed:
Monitoring Web Interface
Figure 135: files transfer page
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 180
General Reference Guide
6.7 Diagnostic
If you encounter problems with your eWON, you will find a lot of information in the diagnostic area of the eWON.
Monitoring Web Interface
Figure 136: Diagnostic page (without ADSL)
The diagnostic area is divided in four or five zones :
• Event Log
• Status
• Scheduled Actions
• Real Time Log
• ADSL Log (on eWON with ADSL modem)
Figure 137: Diagnostic page (with ADSL)
6.7.1
Event Log
The Event Log page shows you the information recorded in the Events.txt file.
In this page, the logged data are presented in reverse chronological order (recent events on the top, older ones at the bottom) on page containing a fixed number of events. These events are displayed in different colors to differentiate
Error
,
Warning
and Trace events.
Navigate
Warning
Trace
Error
RG-001-1-EN rev. 2.1
Figure 138: Event Log page
eWON® - 14/01/2014 - ©eWON sa Page 181
General Reference Guide Monitoring Web Interface
You can customize the information displayed on this page by using the Event Class, Reporting Level and Per Page entry fields.
Figure 139: Customize the Event Log page
Event Class
Reporting Level
Per Page
Allows you to filter the events displayed by categories ( or ALL )
Allows you to filter the events displayed by severity. You view the level choosed and the levels greater. If you select Warning, you will see the warning and Error events.
Defines the number of events you wants to see in each pages.
Table 151: Event Log page parameters
Choose the events that you want to see and validate with the link.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 182
General Reference Guide Monitoring Web Interface
6.7.2
Status
With the Status page, you can access all the internal variables, counters representing the current live status of your eWON. These counters are organized in three main categories: System Counters, I/O Servers counters and System Info.
Figure 140: Status select page
In the first column, you can see an or icon representing the Error or Warning level of this category.
Click on the category link to view different counters/info.
All these counters are accessible from outside of the eWON by FTP in the estat.htm file.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 183
6.7.2.1
Memory Information
General Reference Guide Monitoring Web Interface
6.7.2.2
NAT & IP Forwarding
Figure 141: Memory Information page
Figure 142: NAT & IP Forwarding page
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 184
6.7.2.3
VCom
General Reference Guide Monitoring Web Interface
6.7.2.4
Status
Figure 143: VCom page
Figure 144: Status page
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 185
6.7.2.5
Info
Example of System Info from an eWON 4101 MPI
General Reference Guide Monitoring Web Interface
Figure 145: Info page
6.7.2.6
System
This diagnostics page is available only on eWON Flexy.
It shows the detected Extension Cards.
Example of System info from a Flexy with detected Etension Cards
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 186
General Reference Guide Monitoring Web Interface
6.7.3
Scheduled Actions
The Scheduled Actions diagnostic page shows you the states of the outgoing actions like SendMail, putFTP, getFTP, NTPSynchro, SNMPTrap.
Figure 146: Scheduled Actions page
The Status code can take the following values:
Status code values
0 Ended with Success
-1
>0
In Progress
Ended with Error. The value is the Error code.
See Status As Text column for explanation.
The eWON maintains a list with the status of the last 20 scheduled actions executed.
You can find the same information in the sstat.htm file.
To refresh this page, use the link.
6.7.4
Real Time Log
The Real Time Log diagnostic page shows you the Debug information from VCom, Energy, Serial and VPN.
This logging is a time consuming eWON task and is not activated by default. It will slow down the overall behavior of the eWON.
Use it only during your debugging process !
RG-001-1-EN rev. 2.1
Figure 147: Real Time Log page
eWON® - 14/01/2014 - ©eWON sa Page 187
General Reference Guide
You can select the source of the data to display and the number of events per page with the configuration fields.
Monitoring Web Interface
Figure 148: Real Time Log parameters
These information are stored in RAM memory, they are cleared by an eWON reboot.
6.7.4.1
Activate VCOM debug mode
6.7.4.2
Activate Energy debug mode
Figure 149: Activate VCOM debug
Figure 150: Activate Energy debug
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 188
General Reference Guide Monitoring Web Interface
6.7.4.3
Activate Serial debug mode
You can activate the debug mode on every serial port of the eWON (COM port(s) and internal Modem ports PPP)
In the case of multiple COM ports, the order of appearance including position of the PPP (modem) port depends on the eWON type.
eWON type eWON4002 eWON MPI eWON Flexy 101 & 201 eWON Flexy 103 & 203 eWON Flexy 102 & 202
Other eWONs
COM # and Serial port number
COM: 1 : Debug SER Port1
COM: 2 : Debug PPP Port (modem)
COM: 3 : Debug SER Port2
COM: 4 : Debug SER Port3
COM: 1 : Debug PPP port (if a modem is available)
COM: # : Debug IO/PPP Port# - Depends on the presence/order of Extension Cards.
A modem COM port can be recognized by its label Debug PPP port
Note: the order of COM port recognition is from left to right, top to bottom.
COM: 1 : Debug IO Port1 Debug Serial port 1 (Embedded in Base Unit)
COM: # : Debug IO/PPP Port# - Depends on the presence/order of Extension Cards.
A modem COM port can be recognized by its label Debug PPP port
Note: the order of COM port recognition is from left to right, top to bottom.
COM: 1 : Debug IO port 1
COM: 2 : Debug PPP port ((if a modem is available)
COM: 3: Debug CTRL port (for internal use only)
Table 152: Serial Debug : Serial port available
The example below shows the serial debug page for an eWON2005CD with modem:
Figure 151: Serial Debug Page on eWON2005CD with modem
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 189
General Reference Guide
The example below shows the serial debug page for an eWON Flexy 103/203 with modem:
Monitoring Web Interface
Figure 152: Serial Debug Page on eWON Flexy 103/203 with modem Extension Card
As the Serial Debug uses eWON ressources (CPU and memory), don’t forget to disable the debugging once you don’t need it anymore.
Set the Debug to “No debug” to disable it.
you can also activate the Serial Debug in the configuration file.
Syntax is SerDebX:Y X is the Serial port number and Y is the debug mode
Debug mode value (Y) Description
0 No debug
1
2
3
Hex values Tx & Rx
Hex and Ascii values Tx & Rx
Hex and Ascii values Tx & Rx but Rx timeouts are not logged (clearer in log)
(usefull for Modem debugging)
Table 153: Serial Debug : mode values
The buffer used to store data in the real time log is limited to 500 characters, so if an RX or TX data stream is too long, an error message saying that it is not possible to log it is logged instead
Example: SER-Rx: Too long to print (800)
If the Debug mode is >1 then the ascii values are also logged if there is enough space.
So, even if ascii debug is used, if there is no space, no ascii data are appended to the hex data.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 190
6.7.4.4
Activate VPN debug mode
General Reference Guide Monitoring Web Interface
Figure 153: Activate VPN debug
The VPN diagnosis can be set to 3 levels or disabled.
6.7.5
ADSL Log
If your ADSL does not work, you may have problems with your configuration. In that case, you can check the ADSL Log, this log is fetched from the modem itself and remains in 'English'. It may contain information about an invalid VPI/VCI configuration or an incorrect username and password.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 191
General Reference Guide Retrieving data from eWON
7 Retrieving Data from eWON
7.1
List of eWON files
The eWON flash file system contains the following files (R: read, W: write). Detailed information about files format are contained in the Technical
Notes that you can download from the eWON web site (see
http://support.ewon.biz/redirect/DocTN.htm
):
• TN02: eWON files format
• TN03: ircAll.bin format
• TN12: var_lst.txt format
File Name
Events.htm
sstat.htm
estat.htm
rt_alm.txt
inst_val.txt
inst_val.bin
events.txt
hst_alm.txt
var_lst.txt
var_lst.csv
program.bas
ewonfwr.edf
dump.ppp
config.bin
config.txt
comcfg.txt
ircall.bin
icr_XXXXX.txt
remote.bas
backup.tar
data.tar
W
R
R/W
R/W
R
R/W
R/W
R/W
R/W
R
R
R/W
R/W
R
Type
R
R
R
R
W
R/W
R/W
Description
eWON events occurred (as log in, log out, error) - html format
All the scheduled actions status for the current session - html format
Current status of the eWON - html format
Real time alarms list
Contains the instant values from the Tags that have been defined in eWON - text format
Instant values from eWON's Tags - binary format eWON events occurred (as log in, log out, error) - text format
Historical alarms list - text format
List of all the eWON Tag names which are logged - text format
List of all the eWON Tag names which are logged (csv format)
The whole source code of eWON basic program eWON's firmware file ppp dump file (can be analyzed by using a software that manages the .ppp format) eWON configuration - binary format eWON configuration - text format eWON COM configuration - text format
All the binary values from all Tags that have been defined in eWON
Incremental recording file.
One file per each of the Tags that are listed inside the var_lst.txt file
Single shot execution section (max size = 3000 bytes)
Archive containing all necessary files to backup the eWON.
config.txt, comcfg.txt, program.bas and /usr directory (with subdirs).
When the archive is written, the eWON is firstly cleared before applying the all files.
Archive containing all necessary files to backup the eWON.
config.txt, comcfg.txt, program.bas and /usr directory (with subdirs).
When the archive is written, the eWON is not cleared before applying the all files.
Table 154: eWON files list
• Files ewonfwr.edf and config.bin are binary files and cannot be modify by users. The config.bin file is Read/Write to allow users to
"copy/paste" configuration from one eWON to another.
• The program.bas file is Read/Write; this allows you to design your program offline with your text editor and to upload it to the eWON.
• Remote.bas is not readable. When a remote.bas (max size = 3000 bytes) file is "dropped" in the eWON root directory, this program is executed 1 time. This feature can be used to execute a single shot action in an automated way.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 192
General Reference Guide Retrieving data from eWON
• The following files only appear if the user owns the "Config rights":
• Program.bas
• ewonfwr.edf
• config.bin
• config.txt
• During an FTP session, all the files are read-only, except for users who own the "Config rights".
7.2
Files Format
Files format are text semicolon (;) separated files that may be inserted inside a program such as Excel™. The first row gives the columns names, and the next ones the values of the different columns.
For example, the content of the rt_alm.txt file:
"TagId";"AlarmTime";"TagName";"AlStatus";"AlType";"StatusTime";"UserAck";"Description"
1;"7/09/04 13:19:12";"Level tank A";"ALM";"LOW";"7/09/04 13:19:12";"";"Fuel level on Tank A"
7.2.1
Config.txt : New Line character (NLSeparator)
Firmware 5 specific feature
For technical purposes, the character used (LF char 0x0A) to separate parameters in some fields is replaced by a
¶
.
Fields where
¶
character could be found in config.txt are: IOServerData#, Information of eWON, Description of Tag.
Fields where
¶
character could be found in comcfg.txt are: VPNSecretKey, VPNSecretCert, VPNCACert
With firmware 5, you will find the following parameter:
IOSrvData0:MinInterval:10¶MaxInterval:268435455¶ReverseCount:0
¶
has the ASCII code 182 (0xB6)
The end of the line is always CR+LF (0x0D 0x0A).
With firmware 4, you will find the following parametesr:
IOSrvData0:MinInterval:10
MaxInterval:268435455
ReverseCount:0
ended by a LF character 0x0A ended by a LF character 0x0A ended by a CR+LF characters 0x0D 0x0A
In firmware 5, you can force the use of ’LF’ or ’¶’ with the NLSeparator parameter (in config.txt file).
NLSeparator
0 (default) : use the ’¶’ (0xB6) as separator in IOServerData# field.
1 : use the ’LF’ (0x0A) as separator in IOServerData# field (for compatibility with firmware 4).
note: If the config is cleared or if the eWON is formatted, the NLSeparator returns to 0.
note: When you put a config.txt file by FTP to an eWON with firmware 5, it handles correctly the 2 kinds of separator.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 193
General Reference Guide Retrieving data from eWON
7.3
FTP transfer
FTP stands for the classical File Transfer Protocol used on the Internet.
7.3.1
FTP Software tools
A lot of FTP software tools are available on the market. A very professional freeware FTP software called FileZilla is available at http://filezilla-project.org/ download.php
. This tool allows you to easily manage file retrieving by drag and drop. Please refer to this product's user manual in order to connect to the eWON.
The settings needed to open a TCP/IP connection to the eWON are (with factory settings)
IP address
Login
Password
Port
10.0.0.53
adm adm
21 (default FTP port)
Anonymous unchecked (you are connecting with the above login and password)
7.3.2
FTP session
Using a common FTP session and using all standard FTP command, you can also easily retrieve data from the eWON. The main interest of this method is to automate the upload by an FTP scripting executed automatically.
7.3.3
Via eWON web site
One of the Web pages available within the eWON Web Interface is called Files Transfer. This page contains a table with a list of hyperlinks. The
Hyperlinks can be used to download files directly from the eWON Web Interface.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 194
General Reference Guide Export Block Descriptors
8 Export Block Descriptor
Exports are used to export eWON data.
Export block can be used in the following situations:
• Attach the eWON data to an email
• Include eWON data into an eMail content
• Make an FTP PUT of eWON data from the eWON to a FTP server
• Make an FTP GET from a FTP client out of the eWON FTP server
• Include data in an eWON HTML custom page.
• Access data in Basic with OPEN "exp:....."
In all these cases, an Export Block Descriptor will be used to describe the data to export.
8.1
Export block descriptor
An Export Block Descriptor is a string of characters describing the eWON data to export with a precise syntax.
Typically, the Export Block Descriptor will answer the following questions:
• What eWON data to export (Event log, Historical logging, etc.)?
• How to format the data to export (Binary, Text, Html table, Graphic)?
• From what time?
• To what time?
• What Tag is concerned?
• …?
This list is NOT complete, and this information is not required for each type of data to export, but it gives an idea of what is described in an Export block descriptor.
Example of Export blocks descriptor:
$dtHL $ftT $st_m10 $et_0 $tnMyTag $fnData.csv
The export syntax is composed of a sequence of fields followed by its value. A field is a 3 characters identifier starting with $ and followed by 2 lower cap letters (case sensitive).
• The first letter of the parameter value follows immediately the second letter of the field.
• The parameter is considered up to the first space found or until a $ or a [ is detected.
• The parameter can also be placed between quotes ("). In that case the parameter value is the value between the quotes.
The following fields are defined:
Fields
$dt
$ft
$st
$et
$tn
$ut
$ct
$fl
$fn
Description
Data type
Export format
Start time
End time
Tag name
Update last time
Compression type
Group filter
File name
Table 155: Export Block Descriptor fields description
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 195
General Reference Guide Export Block Descriptors
8.2 Export fields syntax definition
The syntax for the different fields is defined in the following chapters.
8.2.1
$dt [Data Type]
The $dt field defines what data to export from the eWON. The $dt parameter is made up of 2 upper case letters (case sensitive) that can take one of the following values:
RL
SC
SE
SS
HT
IV
PG
PP
$dt Parameter
AH
AR
CF
ES
EV
FW
HL
SV
TL
UF
RE
TR
Description
Alarm history
Alarm Real time
Config estat file
Event file
Firmware
Historical Logging
Historical Table
Instant values
Program
PPP dump file
Real time logging
Communications configuration file
Script Expression
Scheduled status
System Variable
Tag list
User file
Real Time diagnostic
TAR File
Binary
B*
B*
B*
B*
B
B*
B*
B*
B*
Table 156: $dt parameters description
Graph
G
G
T
T*
T
T*
T
T*
T
T
Text
T*
T*
T
T
T*
T
T*
T
T*
H
H
H
H
Html
H
H
H
H
H
H
H
H
(*) The asterisk in the previous table denotes the default value of the $ft (export format). For example, for the DataType HL (Historical Logging), the default export format will be B (Binary) if you do not specify a $ft in your Export Bloc Descriptor (using [$dtHL] is equivalent to [$dtHL $ftB]).
8.2.2
$ft [Format]
The $ft field defines how to format the data exported. The following formats are available:
$ft Parameter
B
G
T
H
Format description
Binary
Graph
Text
HTML Table
Table 157: $ft parameters description
• Binary: the data are sent in a raw binary format, not modified by the export module.
• Graph: the data are used to produce a PNG (Portable Network Graphic) image representing a graph of the values (historical trend or real time graph).
• Text: The data are formatted as a CSV file, this means that each record is represented with each field on a line separated by a semicolon (;). The string fields are written between quotes, each line is ending by a CRLF (0x0D, 0x0A) sequence.
• Html: Instead of the text format, the data are placed in a simple HTML table. This format is useful for inserting data in the user custom
HTML pages.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 196
General Reference Guide Export Block Descriptors
8.2.3
$st [Start Time] and $et [End Time]
These 2 fields are used to limit the time range of an export operation. $st and $et provide the start and end time of the export. The parameter format is the same for both fields. There are 3 different formats for the $st, $et parameter:
• Relative time
• Absolute time
• From last $ut (see also “$ut [Update Time]” on page 198).
8.2.3.1
$st, $et with relative time
Syntax:
$st_([s]|[m]|[h]|[d])100 _ = back
(h,m,s,d = Hour, min, sec, day. 100 is the amount)
This represents a time regarding to the current time expressed in days, hour, minutes or seconds. If no letter is specified minutes are considered.
Examples:
$st_m10
$et_0
$st_d2
10 minutes in the past
0 minutes in the past (= now)
2 days in the past
Table 158: $st with relative time examples
8.2.3.2
$st, $et with absolute time
Syntax:
$stDDMMYYYY[[_HHMMSS][[_mmm][[_I][[_T]]]]]
Where:
DDMMYYYY
HHMMSS mmm
I
T
Means Day, Month, Year, 8 characters. This parameter is required.
Means Hour, Minute, Second, 6 characters. This parameter is optional (0 used by default)
Means milliseconds (000 to 999) 3 characters. This parameter is optional but if present, HHMMSS must also be specified.
Means intra sec counter. This value is present when receiving a historical logging from the eWON. It can be specified in export request to allow precise repositioning in the historical file. This parameter is optional, but if present, HHMMSS and mmm must also be specified.
Means Tag id. As for I, this parameter is used for precise positioning in historical file. This parameter is optional, but if specified, HHMMSS, mmm and I must be present also.
Table 159: $st parameters
When ALL the Tags are specified, the Tag values are output in chronological order. For the same time there can be 2 Tag values. In order to reposition correctly in the file, it is necessary to provide the last Tag output during a previous export.
Examples:
$st01012000_120000
$st01012000_120000_010
1 jan 2000 at 12 AM
1 jan 2000 at 12 AM + 10 msec
Table 160: $st with absolute time examples
8.2.3.3
$st , $et with Last time
By adding the $ut command in an Export Block Descriptor, you can ask the eWON to remember the time of the last point exported, this time can be used for the next export.
The last time is reset when the eWON boots.
Syntax:
$stL
L is the time parameter meaning last time.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 197
General Reference Guide Export Block Descriptors
8.2.4
$ut [Update Time]
This field has no parameter, it means that at the end of this export, the time of the last point exported must be saved in the eWON so that it can be used as a reference time for a later call.
Example:
$stL$et_0$ut
This sequence will specify a time range from last time to current time AND will ask to update the last time at the end of the export.
The last time is stored on a per Tag basis if one Tag is specified for the export. A global last time can also be saved if "ALL Tag" is specified in an export.
8.2.5
$tn [Tag Name]
This field is used to specify a Tag name. It is required for graph commands. The parameter specified is the name of the Tag. When a $tn field can be specified for an export and no $tn is given, then the command is executed for ALL the Tags.
Example:
$tnMyTag
(MyTag is the name of the Tag)
8.2.6
$ct [compression format]
This field is only applicable when sending a file from the eWON to an FTP server, or as an attachment to an email.
The compression format is gzip ( http://www.gzip.org
). So that the unique argument to add after the field "$ct" is "G".
Example:
Putftp "test2.txt.gz","[$dtUF $ctG $uf/test.txt]"
Or:
SENDMAIL "[email protected]", "", "Subject", "Mail body &[$dtUF $ctG
$uf/usr/test.txt $fntest2.txt.gz]"
Note:
If you give to the destination file the ".gz" extension only (and not ".txt.gz" for example), the destination file will be correctly exported, but in this case you will have to indicate the extension when uncompressing (".txt" in the above case).
You can then use a tool such as Winrar* to extract the file; it will be extracted in a folder named "test2.txt".
*You can download a free trial version of this tool at the following address: http://www.rarlab.com/download.htm
.
8.2.7
$se [Script Expression]
This field is only required for $dtSE export data. The $se parameter specifies the "script expression" to compute. Usually, the $se parameter will be inserted between quotes because if a $ is found in the expression it will be considered as the end of parameters.
Example:
$dtSE $se"A$"
(Exports the content of A$)
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 198
General Reference Guide Export Block Descriptors
8.3 Data Types description and syntax
A Data type defines what is exported from the eWON. The data type is defined by the $dt field followed by 2 uppercase letters. The $dt field is mandatory for each "Export Block Descriptor" and usually the $ft (Format) field will also be present to define the output format of your data
(although a default format is defined for each data type).
For each Data type, a set of other fields must be provided (some are mandatory and others are optional).
Note:
If you specify an unused field (neither mandatory nor optional), it will then be ignored.
This section will describe the syntax for each data type with the specific features for each of them.
8.3.1
$dtHL [Historical Logging]
8.3.1.1
Export content
The Historical logging outputs the data from the File system for ONE or ALL the fields. The output format can be TEXT, HTML Table or BINARY.
The GRAPH format is also available IF only ONE Tag is specified.
A time range can also be specified for this export.
8.3.1.2
Detailed Example
$dtHL $ftT $st_h4 $et_m0 $tnA1
$dtHL
$ftT
$st_h4
$et_0
$tnA1
data type historical logging output format requested is CSV start time is current time – 4 hours end time is current time – 0 minutes Ù NOW
Tagname “A1” history to output
Table 161: $dtHL detailed example
8.3.1.3
Used Fields
Fields Value if not specified
Mandatory
$dt
$fl
$ut
$fn
$ct
$ft
$st
$et
$tn
Optional
Binary
01/01/1970
31/12/2030
All tags
All tags groups
No time update
Export block descriptor
Compression type
Table 162: $dt - used fields
8.3.1.4
Special parameters and fields
$st $et
If Last time is specified: ($stL or $etL): there is a last time logged for each Tag plus a last time logged for all Tags. If you specify a given Tag, its own last time will be used. If a specific Tag is not requested, the export is performed for Tags concerned by historical logging and another last time memory is used.
If the output format is graph: $et_0 should be used instead of default value, otherwise the graph would span up to 31/12/2030. For binary or text output, the default value can be kept.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 199
General Reference Guide Export Block Descriptors
$ft
Binary Text
Acceptable values
HTML Graph
Table 163: [$dtHL] $ft acceptable values
The Graph format is only allowed if a Tag has been specified.
The Text format will output a comma-separated file. The separator is ’;’ to avoid any confusion with decimal point. If all the Tags are output they will be output in a chronological order in the file.
$ut
If only one Tag is specified, the time of the last point for that Tag will be memorized. All the Tags can be output individually and last time is saved for each point. Another memory is available if $ut is requested for ALL the Tags.
$tn
If this Tag is not specified, ALL the Tags will be selected for export. Otherwise, the Tag with the given name will be selected.
$fl
The group selection is only available with binary, text and HTML formats (not allowed for Graphic format $ftG).
8.3.1.5
examples
$dtHL
$dtHL $ftT
$dtHL $ftT $tnTemp
$dtHL $ftB $flAB
$dtHL $ftT $tnTemp $st_h1 $et_s0
$dtHL $ftT $flCD $st_h1 $et_s0
export all the Tags records in binary format export all the Tags records in ($ftT) Text format (like CSV file) export all the values of the ($tnTemp) Tag named “Temp” in ($ftT) Text format export all the values of ($flAB) tags belonging to group A and B in ($ftB)
Binary format export the values ($st_h1) from 1 hour to ($et_s0) now of ($tnTemp) Tag named “Temp” in ($ftT) Text format export the values ($st_h1) from 1 hour to ($et_s0) now of ($flCB) Tags belonging to group C and D in ($ftT) Text format
Table 164: [$dtHL] examples
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 200
General Reference Guide Export Block Descriptors
8.3.2
$dtHT [Historical Table]
8.3.2.1
Export content
The historical table is a representation of the IRCALL.BIN (incremental recording).
This representation provides a recordings representation as a table where columns are Tag names and rows are recording times.
The features is also used in the VIEW area (see “Historical table” on page 172).
8.3.2.2
Detailed Example
$dtHT $ftT $st_h4 $et_m0 $flAB $in10
$dtHT
$ftT
$st_h4
$et_0
$flAB
$in10
data type historical table output format requested is text (CSV) start time is current time – 4 hours end time is current time – 0 minutes Ù NOW
Filter to Instant value groups A and B
Interval fixed to 10 seconds
Table 165: $dtHT detailed example
8.3.2.3
Fields used
Fields Value if not specified
Mandatory
$dt
$ft
$st
$et
$fl
$in
8.3.2.4
Special parameters and fields
$ft
Optional
Text
01/01/1970
31/12/2030
All tags are displayed interval from the ircall.bin file
Table 166: $dt - used fields
Text
Acceptable values
HTML
Table 167: [$dtHT] $ft acceptable values
Text format will output a comma-separated file. The separator is ’;’ to avoid confusion with decimal point.
$fl (filter)
The filter can be used like for the instant values ($dtIV), with an additional option 'X'
The $fl can be any string containing A,B,C,D,X.
Example: ACX or BDAX or X
If no filter is specified then all the Tags with an enabled Historical logging are output.
If filter include "X", then tags without Historical logging enabled are also included, this is provided in case recording has been disabled but tags have been previously recorded in the file.
If filter include any of the A,B,C,D, then only the tags that belong to those groups are included in the output.
$in (interval)
The Historical Table time interval definition can follow 2 different standards:
• Historical file defined interval
• Fixed interval
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 201
General Reference Guide Export Block Descriptors
For fixed interval, $in parameter must be used. The interval is defined in seconds.
Example: $in10 to output one value every 10 seconds
If $in is not specified, then the output time is defined by the time in the recording file.
Example:
Let’s assume that we have 2 Tags logged with the following time and values (for clarity, the date has been omitted):
Time Tag Value
10:01:00
10:10:00
Tag1
Tag1
1
1.5
10:10:00
10:11:00
10:12:00
10:21:00
10:30:00
Tag2
Tag1
Tag1
Tag2
Tag1
1
2
3
2
4
If the fixed interval is not requested, then the following output will be produced
Time Tag1 Tag2
1
2
10:01:00
10:10:00
1
1.5
Undef
1
5
6
3
4
10:11:00
10:12:00
10:21:00
10:30:00
2
3
3
4
1
1
2
2
Notes:
At line 1, Tag2 is Undef, because no value are available in the log file.
At line 2, Tag1 and Tag2 are updated at on the same line, although there are 2 records in the incremental recording file, only 1 line is produced.
So, except for the case when multiple Tags changed at the same time, when no interval is specified, the output contains one line for every record that has been logged.
If an interval of 10 minutes has been requested ($in600), then the following output would be produced.
Time Tag1 Tag2
1
2
3
10:01:00
10:11:00
10:21:00
1
2
3
Undef
1
2
Notes:
The output starts with the first time found in the file then it increases by 10 minutes.
There is no record with time equal (or higher) to 10:31, so the last line is 10:21
If an interval of 10 minutes is requested and the start time is 10:00, then the following output would be produced.
Time Tag1 Tag2
1
2
10:00:00
10:10:00
Undef
1.5
Undef
1
3
4
10:20:00
10:30:00
3
4
1
2
Notes:
On the first line, no values are available for Tag1 or Tag2 before 10:01:00 (for tag Tag1) in the recording file, so the values are Undef.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 202
General Reference Guide Export Block Descriptors
8.3.3
$dtRL [Real time Logging]
8.3.3.1
Export content
The Real time logging outputs the data from the File system for ONE Tag. The output format can be TEXT, HTML Table, BINARY or GRAPH. A time range can also be specified for this export.
8.3.3.2
Detailed Example
$dtRL $ftG $st_m10 $et_m0 $tnA1
$dtRL
$ftG
$st_m10
$et_0
$tnA1
A1
data type Real time logging output format requested is GRAPH start time is current time – 10 minutes end time is current time – 0 minutes Ù NOW
Tag log to output
Name of the Tag
Table 168: $dtRL - detailed example
8.3.3.3
Used Fields
Fields Value if not specified
Mandatory
$dt
$tn
$ft
$st
$et
$ut
$fn
$ct
Optional
Binary
01/01/1970
31/12/2030
No time update
Export block descriptor
Compression type
Table 169: $dtRL - fields used
8.3.3.4
Special parameters and fields
$st $et
If the output format is "graph", $et_0 should be used instead of default value, otherwise the graph would span up to 31/12/2030. For binary or text output, the default value can be kept.
$ft
Binary Text
Acceptable values
HTML Graph
Table 170: [$dtRL] $ft - acceptable values
Text format will output a comma-separated file. The separator is ’;’ to avoid any confusion with the decimal point.
$tn
A Tag MUST be specified for this export (does not work on ALL the Tags).
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 203
General Reference Guide Export Block Descriptors
8.3.4
$dtAH [Alarm History]
8.3.4.1
Export content
The Alarm History outputs data from the File system for ONE or ALL the Tags. The output format can be TEXT or HTML Table.
A time range can also be specified for this export.
8.3.4.2
Detailed Example
$dtAH $ftH $st01012001
$dtAH
$ftH
$st01012001
$et
$tn
data type Alarm history logging output format requested is HTML table
1 st
of January 2001 not specified Î until the end of file not specified Î all the Tags
Table 171: $dtAH - detailed example
8.3.4.3
Fields used
Fields Value if not specified
Mandatory
$dt
$ut
$fn
$ct
$ft
$st
$et
$tn
Optional
Text
01/01/1970
31/12/2030
All
No time update
Export block descriptor
Compression type
Table 172: $dtAH - fields used
8.3.4.4
Special parameters and fields
$ft
Text
Acceptable values
HTML
Table 173: [$dtAH] $ft - acceptable values
Text format will output a comma-separated file. The separator is ’;’ to avoid any confusion with the decimal point. If all Tags are output they will be output in a chronological order in the file.
Line content of output file:
"EventDate";"TagName";"Status";"UserAck";"Description"
$tn
If this Tag is not specified, ALL the Tags will be selected for export. Otherwise, the Tag with the given name will be selected.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 204
General Reference Guide Export Block Descriptors
8.3.5
$dtAR [Alarm Real time]
8.3.5.1
Export content
The Alarm Real time outputs the real time data for ONE or ALL the Tags. The output format can be TEXT or HTML Table. If only ONE Tag is specified, 1 or 0 lines will be appended to the output header line (Time range is not applicable here).
8.3.5.2
Detailed Example
$dtAR $ftT
$dtAR
$ftT
$tn
data type Alarm Real time output format requested is CSV not specified Î all Tags
Table 174: $dtAR $ft - detailed example
8.3.5.3
Fields used
Fields Value if not specified
Mandatory
$dt
$ft
$tn
$fn
Optional
Text
All
Export block descriptor
Table 175: $dtAR - fields used
8.3.5.4
Special parameters and fields
$ft
Text
Acceptable values
HTML
Table 176: [$dtAR] $ft -acceptable values
Text format will output a comma-separated file. The separator is ’;’ to avoid confusion with the decimal point. If all the Tags are output, they will be output in a chronological order in the file. Line content of output file:
"TagId";"AlarmTime";"TagName";"AlStatus";"AlType";"StatusTime";"UserAck";"Description"
$tn
If this field is not specified, ALL the Tags will be selected for export. Otherwise, the Tag with the given name will be selected.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 205
General Reference Guide
8.3.6
$dtEV [EVent file]
8.3.6.1
Export content
The Event file outputs data from the File system. The output format can be TEXT or HTML Table.
A time range can also be specified for this export.
8.3.6.2
Detailed Example
$dtEV $ftT $st_m30
Export Block Descriptors
$dtEV
$ftT
$st_m30
$et
data type events logging output format requested is CSV last 30 minutes not specified Î until now
Table 177: $dtEV - detailed example
It will output a CSV file containing the events during the last 30 minutes.
8.3.6.3
Fields used
Fields Value if not specified
Mandatory
$dt
$ft
$st
$et
$fn
$ct
Optional
Text
01/01/1970
31/12/2030 Ù NOW
Export block descriptor
Compression type
Table 178: $dtEV - fields used
8.3.6.4
Special parameters and fields
$ft
Text
Acceptable values
HTML
Table 179: [$dtEV] $ft - acceptable values
Text format will output a comma-separated file. The separator is ’;’ to avoid any confusion with the decimal point.
Line content of output file:
"EventTimeInt";"EventTimeStr";"Event"
EventTimeInt
EventTimeStr
Time provided as an integer (number of seconds since 1/1/1970)
Date and time as text
Table 180: EventTime types
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 206
General Reference Guide Export Block Descriptors
8.3.7
$dtSS [Scheduled Status]
8.3.7.1
Export content
The scheduled actions are actions that are executed in a scheduled manner, for example: PutFTP, Send Mail, Send SMS.
When one of these actions is requested, it does not occur immediately, but it is queued for a sequential execution. This export allows checking the content of this queue and giving the status of all the actions in queue: "in progress", "executed (success)" and "executed with error".
8.3.7.2
Detailed Example
$dtSS
8.3.7.3
Fields used
Fields Value if not specified
Mandatory
$dt
$ft
$fn
Optional
Text
Export block descriptor
Table 181: $dtSS - fields used
8.3.7.4
Special parameters and fields
$ft
Text
Acceptable values
HTML
Table 182: [$dtSS] $ft - acceptable values
Text format will output a comma-separated file. The separator is ’;’ to avoid any confusion with the decimal point. Line content of output file:
"ActionId","ActionType","StatusCode","StatusText","Start","End"
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 207
General Reference Guide Export Block Descriptors
8.3.8
$dtSE [Script Expression]
8.3.8.1
Export content
This export provides a means to get the content of a script expression. The script expression is a standard eWON Basic-like expression returning a STRING, and INTEGER or a FLOAT. The evaluation of the expression will always occur between 2 scripts execution, for example between 2
ONTIMER executions, or between 2 cycles of the cyclic sections.
8.3.8.2
Detailed Example
$dtSE $se"A$"
8.3.8.3
Fields used
Fields Value if not specified
Mandatory
$dt
$se
$ft
$fn
Optional
Binary
Export block descriptor
Table 183: $dtSE - fields used
8.3.8.4
Special parameters and fields
$ft
Text
Acceptable values
HTML Binary
Table 184: [$dtSE] $ft - acceptable values
Binary and Text format means that the output is the content of the Script Expression itself.
HTML output supposes that the content of the script expression is a comma-separated data (string between quotes, items separated by ’;’ and end of lines marked with CRLF (0x0d, 0x0a)). Then the exported output is an HTML table containing these data.
$se
Defines the script expression to output, usually this expression is typed between quotes because $ characters are considered as separator otherwise.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 208
General Reference Guide
8.3.9
$dtUF [User File]
8.3.9.1
Export content
The User File export returns the content of a file in the User File area (/usr/ directory – or subdirectory).
When the file is exported, the <%#ParamSSI> and <%#TagSSI> Tags are replaced by the actual values.
8.3.9.2
Detailed Example
$dtUF $uf/ufdir/uf1.txt
Export Block Descriptors
$dtUF
$uf/ufdir/uf1.txt
User file
Will export the uf1.txt file located in the /usr/ufdir directory
8.3.9.3
Used Fields
Fields Value if not specified
Mandatory
Must always precede "UF": dtUF (means Data Type= User File)
$dt
$uf
Optional
$fn
$ft
$ct
$fl
Binary no compression
Table 185: $dtUF - used fields
8.3.9.3.1
$uf [User File Name]
This field is the name of the user file that you want to export (source name).
The file name can be preceded by the name of the subdirectory inside the /usr directory:
/myfile.txt
(myfile.txt is in the /usr directory)
Note: The first "/" is optional.
/mydir/myfile.txt
(myfile.txt is in the /usr/mydir directory)
Note: The first "/" is optional.
The complete path can also be specified:
/usr/myfile.txt
(myfile.txt is in the /usr directory)
Note: The first "/" is optional.
/usr/mydir/myfile.txt
(myfile.txt is in the /usr/mydir subdirectory)
Note: The first "/" is optional.
Example:
Putftp "/test.txt","[$dtUF $uf/myfile.txt]"
8.3.9.3.2
$fn [Destination File Name]
This field is used for specifying a file name to the export data (destination name). Usually this file name is used to specify the output of the data, for example when sending an attachment to an email. In this case, the $fn file name gives the name of the attachment:.
SENDMAIL "[email protected]", "", "Mail Subject", "&[$dtUF $uf/myfile.txt $fnNewName.txt]"
The above example will attach to an eMail a file named “NewName.txt” that is a copy of the file “/usr/myfile.txt”.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 209
General Reference Guide Export Block Descriptors
There is also one special use of the $fn: when a user file ($dtUF$fn) is exported and you do not specify the source name ($uf); in that case, the
$fn parameter is used as source and as destination file name.
Using only $fn in a send mail string:
SENDMAIL "[email protected]", "", "Mail Subject", "Mail text &[$dtUF$fnmyfile.txt]"
Use the above syntax will attach a file with its name (and not with the EBD syntax as name).
note: pay attention that all ‘/’ (slash) character into the $fn parameter will be replaced by a ‘_’ (underscore) character.
When doing a PUTFTP, then $fn does not need to be specified, because the PUTFTP command manages the name of the destination file:
PUTFTP "MyFileWithANewName.txt", "[$dtUF $uf/myfile.txt]"
8.3.9.3.3
Special parameters and fields
• $ftB "File Type" binary (default). Other types are unavailables (HTML, Text or Graph)
• $ctG "Compression Type" GZ.
• $flNOSSI "Disable SSI parsing in $dtUF".
When the $dtUF export bloc descriptor is used to export a user file then eWON will parse the user file during export for any SSI tag (tags starting with <%#). In some cases this behavior is not wanted (in case the file may contain the <%# sequence but no SSI are used).
The $flNOSSI can be used to disable SSI parsing in $dtUF
IMPORTANT: NOSSI must be entered in caps (case sensitive) example:
$dtUF $uf/usr/MyFile.bin $flNOSSI $fnOutFile.bin
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 210
General Reference Guide Export Block Descriptors
8.3.10
$dtIV [Instant Values]
8.3.10.1
Instant value - general information
Instant value means values of Tags at a given time. The file of instant value contains for each Tag the following information:
TagId
TagName
Value
AlStatus
AlType
Id of the Tag
Name of the Tag (in text mode)
Current value of the Tag
Current alarm status of the Tag
Type of the current alarm
Table 186: $dtIV - instant value file’s informations
• The file containing the instant values for every Tag is available in binary or text format; you can download the instant values file directly from the root of the eWON root file list, or you can address it by using an Export Block Descriptor.
• The instant values file normally contains all the Tags, but there is an additional feature that allows obtaining only the instant values from specific Tags.
• In the Tag definition, there is a new config in the "Tag visibility section".
• There is a group of 4 check boxes, each of them being associated to a group called A, B, C, D (4 groups).
• Every Tag can belong to no group, one group, or more than one group.
• These groups are only used when reading the instant values using an Export Block Descriptor; in that case there is an additional field in the Export Block Descriptor. That allows to request the instant values for the Tags belonging to one or more groups.
IMPORTANT:
Regardless of the group definition for each of the Tags, the inst_val.txt and inst_val.bin files (see below) always return the instant value for ALL Tags.
These groups have nothing in common with the A, B, C topics of the IO servers. They are defined in the context of the Instant
Values!
• Root file access
In the eWON root folder (FTP access or file transfer) you will find the following 2 files:
inst_val.txt
inst_val.bin
instant values in text mode instant values in binary mode
8.3.10.2
Alarm status code values
The below table lists the different values that the field AlStatus can have, depending on the Alarm State and of the action the user has performed on it:
Alarm Status
NONE
PRETRIGGER
ALM
ACK
RTN
Alarm Status
Value
0
Alarm status explanations
1
2
3
4
Tag is not in alarm status
Tag is in pretrigger alarm statusWarning: we assume there is no alarm if
AlStatus value <= Alarm Pretrigger
Tag’s alarm status is active
Tag’s alarm has been acknowledged
Tag’s alarm returns from an active status
Table 187: inst_val.txt file - alarm status code values
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 211
General Reference Guide Export Block Descriptors
8.3.10.3
Alarm type values
The table below lists the different values that the field AlType can have, depending on the type of threshold that has been stepped over by the
Tag value, depending on the configuration set in the Tag’s configuration page:
Alarm Type
NONE
HIGH
LOW
LEVEL
HIGH_HIGH
LOW_LOW
Alarm Type Value
0
1
2
3
4
5
Alarm type explanations
The Tag value is inside of the limits beyond of which the alarm is triggered
The Tag value exceeds the value entered in the Alarm Level High field from the Tag configuration page
The Tag value is less than the value entered in the Alarm Level Low field from the Tag configuration page
The Tag value matches the Boolean Alarm Level value defined in the Tag configuration page
The Tag value exceeds the value entered in the Alarm Level HighHigh field from the Tag configuration page
The Tag value is less than the value entered in the Alarm Level LowLow field from the Tag configuration page
Table 188: inst_val.txt file - alarm type values
8.3.10.4
Writing Instant Values to the eWON
The instant values file can also be written to the eWON. The file must be written by FTP to the ftp root folder and must be written to the file.
All the Tags value present in the file will be used to change the corresponding Tag in the eWON. If a Tag is not found, then it will be ignored.
• Writing in binary format:
• The file format must comply exactly with the definition (see below) and all Tags are identified by their Tag ID.
• Writing in text format:
• When writing the instant value in text format, there are different possibilities to address the Tag:
• If a "TagName" column is present, then the Tags will be accessed by their name (even if a "TagId" column is present)
Example:
"TagId";"TagName";"Value";"AlStatus";"AlType"
1;"M1";10.000000;0;0
2;"M2";20.000000;0;0
If a "TagName" column is NOT present, the Tags will be accessed by their id:
"TagId";"Value";"AlStatus";"AlType"
1;10.000000;0;0
2;20.000000;0;0
WARNING:
Remember that the Tag Id is not an index, but a unique number that has been allocated to the Tag when created, and cannot be reused unless the configuration is erased and a new configuration is created.
8.3.10.5
Binary file format
The file starts with a Header that can be represented by the following C structure:
struct InstantValueHeader
{
int Rev;
int RecSize; //Record size
int NbTag; //Number of Tags exported
int RecFlag; //Reserve (must be set to 0)
int Reserved2;
}
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 212
General Reference Guide Export Block Descriptors
Then there is a record number for each Tag (the record number can be obtained from the header (NbTag):
struct InstantValueRecord
{
int TagId;
float Value;
int AlStatus;
int AlType;
int Reserved;
}
WARNING:
All data in these records are stored in BigEndian
Until more information is available in this chapter, please refer to "Technical Note 03" for more information about eWON's data representation of floats and big endian format (http://support.ewon.biz).
8.3.10.6
Export content
The $dtIV Tag exports either the entire content of the Instant Value file (txt or binary format) or only a part of it, depending on the parameters that might have been defined with the $fl field.
8.3.10.6.1
Detailed examples
$dtIV $flAB
$dtIV $flA
$dtIV $fl
$dtIV $flABCD
$dtIV
Will export all the Tags belonging to group A or B
Will export all the Tags belonging to group A
Will export no Tag (useless)
Will export all the Tags belonging to group A or B or C or D (but missing Tags that belong to no group)
Will export all the Tags regardless of group definition
Table 189: $dtIV - detailed examples
8.3.10.6.2
Fields used
Fields Value if not specified
Optional
$fl
$ft
Text
Table 190: $dtIV - used fields
8.3.10.7
$fl [Group or Groups]
The $fl (for filter) field must be directly followed by a list of one or more groups A, B, C or D (that have been checked in the Tag's configuration).
There must be no other character in the filter and all the groups must be in uppercase.
Example:
$dtIV $flAB
It will export all the Tags belonging to group A or B.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 213
General Reference Guide Export Block Descriptors
8.3.11
$dtSV
8.3.11.1
Export content
$dtSV returns the value of a defined eWON system variable. A typical use is when the user wants to include the eWON online IP address in an email by using the sendmail Basic syntax. The output format can only be of TEXT type.
8.3.11.2
Detailed Example
sendmail "[email protected]","","Ip","The eWON online IP'address is:
[$dtSV$seOnlineIpAddr]"
$dtSV
$se
OnlineIpAddr
Data type system variable
Will export a system expression
The current eWON online IP address (ie. 192.168.10.15)
Table 191: $dtSV - detailed example
Will include the eWON online IP address in the body from a sent eMail.
8.3.11.3
Used Fields
Fields
$se
Value if not specified
Mandatory
System expression. At this time, only "OnlineIpAddress" is available
Table 192: $dtSV - fields used
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 214
General Reference Guide Export Block Descriptors
8.3.12
$dtPP
8.3.12.1
Export content
$dtPP exports the dump.ppp file (binary format): the file in which the online eWON activity is logged. The output format can only be of BINARY type.
8.3.12.2
Detailed Example
sendmail "[email protected]","","eWON PPP dump","&[$dtPP$fndump.ppp]"
$dtPP
$fn
Data type PPP dump
Will give the required name to the file
Table 193: $dtPP - detailed example
Will attach the eWON PPP dump file to a the eMail.
8.3.12.3
Used Fields
Fields
$fn
Value if not specified
Optional
File name
Table 194: $dtPP - used fields
8.3.13
$dtES
8.3.13.1
Export content
$dtES exports the estat.htm file : the file that lists the current status from the main eWON features. The output format can be TEXT or HTML.
8.3.13.2
Detailed Example
sendmail "[email protected]","","eWON estat file","&[$dtES$ftH$fnestat.htm]"
$dtES
$ftH
$fn
Data type estat file
Will export the file in htm format
Will give to the file the required name
Table 195: $dtES - detailed example
Will attach the eWON estat.htm file to the eMail.
8.3.13.3
Fields used
Fields
$ft
$fn
Value if not specified
Optional
File type
File name
Table 196: $dtES - fields used
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 215
General Reference Guide Export Block Descriptors
8.3.14
$dtSC
8.3.14.1
Export content
$dtSC exports the communications configuration file (comcfg.txt): the file that lists the current status of the main eWON communication features.
The output format can be TEXT or HTML.
8.3.14.2
Detailed Example
sendmail "[email protected]","","eWON COM config file","&[$dtSC$ftH$fncomcfg.htm]"
$dtSC
$ftH
$fn
Data type COM config file
Will export the file in htm format
Will give to the file the required name
Table 197: $dtSC - detailed example
It will attach the eWON comcfg.htm file to the eMail.
8.3.14.3
Used Fields
Fields
$ft
$fn
Value if not specified
Optional
File type
File name
Table 198: $dtES - used fields
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 216
General Reference Guide
8.3.15
$dtRE [Real Time Diagnostic]
8.3.15.1
Export content
$dtRE exports the Real Time Diagnostic data (equivalent to the real tiime log, see “Real Time Log” on page 182)
The output format can be TEXT only.
8.3.15.2
Detailed Example
sendmail "[email protected]","","eWON Real Time Log","&[$dtRE$fndiag.txt]"
It will attach to an email the file "diag.txt" holding the real time diagnostic of the eWON.
$dtRE
$fn
Data type : Real Time Diagnostic
Will give to the file the required name
Table 199: $dtRE - detailed example
8.3.15.3
Used Fields
Fields
$ft
$fn
Value if not specified
Optional
File type (only T available)
File name
Table 200: $dtRE - used fields
Export Block Descriptors
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 217
General Reference Guide Export Block Descriptors
8.3.16
$dtTR [TAR file]
8.3.16.1
Export content
$dtTR exports the eWON file(s) inside a TAR formated file.
The data to include in the TAR file can be defined using a single file list, a directory and wildcard '*', or/and another export block descriptor's.
8.3.16.2
Detailed example
$dtTR $fnmytar.tar $td{/usr/*}
Put the complete /usr directory in the mytar.tar file.
$dtTR
$td
$fn
Data type : TAR file
Data : {/usr/*} the complete /usr directory mytar.tar
Table 201: $dtTR - detailed example
8.3.16.3
Used Fields
Fields
$td
$fn
Value if not specified
Mandatory
Data
File name
Optional
B $ft
$ct
Table 202: $dtTR - used fields
8.3.16.3.1
$fn [output filename]
$fn is used to define a name for the output file.
example: $fnMyDataFile.tar will produce a TAR file with the name "MyDataFile.tar".
8.3.16.3.2
$td [TAR data]
The data consists in a list of items separated by ',' (comma).
The items are specified between "{ }" (curly brackets).
$td {item1},{item2},...,{itemX}
Each item is one of these:
• A /usr file name (complete path to file)
• A /usr directory name (complete path to directory) followed by *
• An export block descriptor
If the path represents a directory followed by * then the whole tree is exported.
8.3.16.4
TAR format and eTAR modified format
The TAR file produced by the eWON could be :
- a standard TAR file, compliant to the USTAR (Uniform Standard Tape Archive) format.
- a modified TAR file, called eTAR.
Standard TAR file can be opened by most of Packager Program like Winzip, WinRar.
Due to technical reasons, the eWON produces an eTar format when the package holds file(s) belonging to the eWON root directory.
This eTAR file is viewed as a "corrupted file" by Packager Program. But, you can use our eTar.exe tools to reformat this eTAR as a valid TAR file.
You can find this eTar.exe program on http://ftp.ewon.biz/software/divers/etar.zip
.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 218
General Reference Guide Export Block Descriptors
8.3.16.5
Examples
$dtTR $fnmytar.tar $td{/usr/file1.txt}
Will make a TAR file named "mytar.tar" containing the file /usr/file1.txt
$dtTR $fnmytar.tar $td{/usr/MyFile1.txt},{/usr/MyFile2.txt}
Will make a TAR file named "mytar.tar" containing the files /usr/MyFile1.txt and /usr/MyFile2.txt
$dtTR $fnmytar.tar $td{$dtCF $ftT $fnMyConfig.txt}
Will make an eTAR file named "mytar.tar" containing the eWON configuration file named "MyConfig.txt"
$dtTR $fnmytar.tar $td{/usr/file1.txt},{$dtCF $ftT $fnMyConfig.txt}
Will make an eTAR file named "mytar.tar" containing the eWON configuration file named "MyConfig.txt" and the file /usr/file1.txt
$dtTR $fnmytar.tar $td{/usr/*}
Will make a TAR file named "mytar.tar" containing all the /usr directory
$dtTR $fnmytar.tar.gz $ctG $td{/usr/*}
Will make a compressed TAR file named "mytar.tar.gz" containing all the /usr directory
$dtTR $fnmytar.tar $td{/usr/*},{$dtPG $fnprogram.bas},{$dtCF $ftT
$fnconfig.txt},{$dtSC $ftT $fncomcfg.txt}
Will make an eTAR file named "mytar.tar" containing
all the /usr directory,
the program file named "program.bas",
the configuration file named "config.txt"
and the communication configuration file named "comcfg.txt"
putftp "Test_TAR.tar","[$dtTR $td{/usr/Page1.shtm},{/usr/Page2.shtm}]"
Will put by FTP the file "Test_TAR.tar" containing the files Page1.shtm and Page2.shtm.
Note that for FTP action, the filename is the first parameter of the PutFTP instruction, then the $fn parameter is not required in the TAR command.
note: It is forbidden to include an item that described a TAR format itself.
THE TAR IS NOT RECURSIVE !
Forbidden example: $dtTR $td{ $TR ……….. }
8.3.17
Additional exports available
$dtTL
$dtPG
$dtCF
Tag List
Program
Configuration File
Table 203: additional exports available
These are all the files from the eWON configuration. They are equivalent to the file available through the eWON FTP server.
RG-001-1-EN rev. 2.1
eWON® - 29/11/2013 - ©eWON sa Page 219
General Reference Guide Upgrading the eWON firmware
9 Upgrading the eWON firmware
9.1 Purpose
There are two ways to upgrade the eWON firmware: by using eBuddy, the eWON utility designed to set up the eWON, or by directly uploading a new firmware on the eWON by means of a FTP client.
9.2 Update firmware with eBuddy
eBuddy allows you to update your eWONs with the latest firmware versions that are available for download from the eWON web site. eBuddy downloads the firmwares and it stocks them in a folder on the local machine.
When you use the Update Firmware feature, eBuddy compares the firmware on the selected eWON with the latest firmwares, and it proposes to you to upgrade your eWON with one of the stored and up-to-date firmwares.
That means you first have to update eBuddy itself prior to upgrade the eWON firmware (please refer to the “eBuddy User Guide” you can download from Support/Documentation/User guides on http://wiki.ewon.biz/support/07_Documentations/01_RG ).
The second link in the eBuddy Wizard home page is used if you want to update the firmware from one of the eWONs on your network. Click on the link to launch the wizard.
Note for the eWON Flexy: In addition to the Update Firmware function, the eWON Flexy family features a Flexy Recovery procedure. The
Flexy Recovery procedure is required in two cases:
• When the Update is major (has low level impact)
• When trying to recover after a system crash
The Flexy recovery procedure is explained in § 9.4 “The Flexy Recovery procedure”
Select an eWON, either by entering directly its serial number or by choosing it in the Select an eWON dialog box; enter the login and password for the eWON, then click on Next in the Update Firmware Wizard.
Select the firmware Language and Version you want to apply, then click Next.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 220
The new firmware is uploaded to the selected eWON:
General Reference Guide Upgrading the eWON firmware
Click on Next when upload is complete, the following dialog box then appears. Please DO NOT power OFF the eWON when it restarts, or this could lead to make it unusable.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 221
General Reference Guide
Click on the Finish Button when the upgrade is complete and exit from the Wizard.
Upgrading the eWON firmware
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 222
General Reference Guide Upgrading the eWON firmware
9.3 Upgrading the eWON firmware by a direct upload
The eWON’s firmware can also be upgraded using FTP.
Just download the eWON firmware file (ewonfwr.edf) corresponding to your eWON type from our web site (http://support.ewon.biz
), and put this file on your eWON using FTP.
You can do this using any FTP client program, just be sure that you use the binary transfer mode and not ASCII.
If you don't have a FTP client program, you can download the SmartFTP tool available on our Web site http://support.ewon.biz
.
To upgrade the eWON firmware using for example SmartFTP as FTP client, please follow the following instructions:
• Start the SmartFTP program.
• Type in the eWON IP address in the "URL" field, the user name in the "Login" field and the user password in the "Password" field.
Figure 154: Connection to eWON through SmartFTP
• Click on the "Connect" icon in the SmartFTP window to connect to the eWON with the parameters that you entered. A new window appears showing all the files that are present in the WON.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 223
General Reference Guide Upgrading the eWON firmware
• Simply drag the new firmware to be uploaded (from your local hard disk or from another FTP folder) and drop it to the root of the eWON file system (here the window is named "10.0.120.11"). A confirm window will appear asking you the action to be performed.
Figure 155: eWON firmware overwrite confirmation window
• Click on the Overwrite button and wait the fill in (blue) of the progress bar in the left bottom side of the window.
Figure 156: eWON upload firmware action
• Click on the "Disconnect" icon to exit the connection to the eWON and quit the SmartFTP program.
WARNING:
When you click on the "Disconnect" icon, the eWON begins a flash memory programming operation (about one minute long).
Do NOT power off the eWON during this operation. If you have a look at the eWON STATUS led, it will be blinking red about once a second. When it finishes blinking, the eWON will reboot. The reboot operation can be observed on the Ethernet link led, going off and then back on again.
Please do NOT remove power until you can get access to the eWON using your web browser of FTP browser. Failure to do so can lead to the destruction of the eWON and a factory return would be unavoidable.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 224
General Reference Guide Upgrading the eWON firmware
9.4 The Flexy Recovery procedure
The Flexy Family features a Recovery Mode that is basically meant to replace both the firmware and the kernel (operating system). The Flexy
Recovery procedure is meant either to implement major firmware updates OR to recover from a system crash.
Warning
: ALL data will be lost!
Before starting, you should:
• Make a backup of your eWON if you need the data of it (provided your eWON is still accessible).
• Have downloaded the recovery firmware file with eBuddy (using Update eBuddy)
• Connect your PC and your eWON Flexy to a hub or a switch (a direct connection PC > Flexy is most unlikely to work)
Open eBuddy (version 3.0 or later). Select Tools > Flexy Recovery from the main menu..
Fill-out the serial number of the eWON Flexy to recover and click Next eBuddy checks whether the eWON Flexy is reponsive or not. If it is, then a warning suggests to switch to the regular update procedure. If not of if you need to upgrade the kernel keep the recovery option and click Next to continue.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 225
General Reference Guide Upgrading the eWON firmware
Select the recovery firmware file version from the dropdown menu. This is the file you have downloaded before starting, using the function update eBuddy..
Follow the instructions of the next step: unpower the eWON Flexy, press the BI1 (reset) button and power it back while BI1 remains pressed. You can release the button as soon as the message disappears.
Troubleshooting: If the process of Scanning network remains running and that the message does not disappear, it probably means that you connected your PC to the eWON Flexy directly. Retry with a connection through a hub or switch.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 226
General Reference Guide Upgrading the eWON firmware
Now the wizard asks you to press the BI1 button twice, do so and allow some time for the Flexy Recovery process to complete
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 227
General Reference Guide Upgrading the eWON firmware
When the Flexy Recovery procedure is completed, you need to make a reset level 2 before starting to use your eWON.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 228
General Reference Guide Upgrading the eWON firmware
9.5 Downgrade firmware
9.5.1
Firmware prior to 5
On firmware version prior to 5.x, the downgrade procedure is the same as the upgrade procedure :
- use the "ewonfwr.edf" of the target firmware and copy it on the eWON root directory by FTP.
Note: After a downgrade, it is recommended to format completely your eWON.
9.5.2
Firmware version 5.x (and above)
On firmware version 5.x (and above), to downgrade your eWON:
- the firmware file "ewonfwr.edf" need to be renamed in "dewonfwr.edf" (note the leading ’d’)
- copy this dewonfwr.edf on the eWON root directory by FTP.
Note: You need to rename the ewonfwr.edf file only for downgrading !
Service release firmware versions are not considered as downgrade.
Examples:
5.0 is lower than 5.1
5.0 S4 is not lower thant 5.0 S7 (Service release on the same firmware version 5.0)
4.3 is lower than 5.0
The download operation is slightly diffrent: when the flashing operation starts, the led will first flash red – green – off repetitively, then the normal flashing sequence with red flash will start.
The first operation consists in a complete memory erasure.
Important : This downgrade erases ALL eWON configuration files (comcfg.txt too) !
The eWON IP address return to 10.0.0.53 and modem parameters return to default.
Never do a downgrade from a 5.x firmware version remotely !
So please backup the txt config version, comcfg, and /usr data before downgrading.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 229
General Reference Guide Upgrading the eWON firmware
9.6 Upgrade Bootloader (to upgrade to firmware >= 5.2)
Since firmware version 5.2, the Bootloader of the eWON must be greater than 2.0.
Every eWON produced with a serial number greater or equal to 0648-xxxx-xx have already this bootloader 2.0.
The eWON produced before 0648-xxxx-xx exceptionally need to be upgraded. The Bootloader 2.0 is required to upgrade eWON to firmware 5.2.
In order to do that, a bootldr.bin file must be downloaded in the eWON by FTP. There is no need to reboot after the bootloader upgrade.
You can find the bootldr.bin file on the eWON website http://support.ewon.biz
in the "Support - Download Firmware" section.
The eWON data or config is NOT affected by this upgrade.
Important: You should not remove the power during a bootldr upgrade.
9.6.1
Error Message
If a firmware with revision >=5.2 is downloaded in the eWON, and the bootloader has not a version > 2.0, the eWON will generate an error and the firmware will be refused.
A simple download of the bootloader will solve the problem and allow you to download the >=5.2 firmware.
For firmware <5.1 (5.0, 4.3, etc..), in the Event Log (or in Events.txt file) the message will be "riftp-Invalid EDF revision"
For firmware >=5.1 (5.1, 5.1s1, 5.1s2) , in the Event Log (or in Events.txt file) the message will be "Bootloader upgrade required"
9.6.2
Checking your boot loader version
It can be checked in the estat.htm file or with Export Bloc Descriptor $dtES.
SIFBootldrRev:00020003
Or in the Diagnosis/status/Info page:
In the above examples, the Bootloader version is 2.3.
note: bootloader version display only available since eWON firmware 5.2
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 230
General Reference Guide Appendix
10 Appendix
10.1 Access to the eWON Technical Support
To find answers to your questions, first check our Support website on: http://support.ewon.biz
If you need further assistance please fill-out the support request sheet on: http://www.ewon.biz/en/support/support.html
10.2 Tips for Internet setup
10.2.1
Finding the IP address of a given host
The eWON does provide DNS (Domain Name Server) resolution. But, sometimes, it’s faster to access Internet nodes by its IP address.
In order to find the address corresponding to a given name, you can use the ping –a NodeName command. This command will return miscellaneous information including the IP address of NodeName that you need.
Example:
C:\>ping -a microsoft.com
Pinging microsoft.com [207.46.197.101] with 32 bytes of data:
Destination host unreachable.
Destination host unreachable.
Destination host unreachable.
Destination host unreachable.
Ping statistics for 207.46.197.101:
Packets: Sent = 4, Received = 0, Lost = 4 (100% loss),
Approximate round trip times in milli-seconds:
Minimum = 0ms, Maximum = 0ms, Average = 0ms
The microsoft.com IP address reported is 207.46.197.101 for this example.
10.3 Finding your PC IP address
Under Windows 95/98, the WINIPCFG command (executed from a command prompt or from the START/RUN menu) will return your Ethernet and PPP adapter IP address. If not currently connected through PPP, the PPP IP address is N/A.
WINIPCFG DOS command does not exist anymore on Millennium, Windows NT, 2000 and XP systems.
The IPCONFIG command can be used instead. This command must be executed from a command prompt and displays as text the IP address of all the TCP/IP adapters that are detected.
Example:
C:\>ipconfig
Windows 2000 IP Configuration
Ethernet adapter Local Area Connection:
Connection-specific DNS Suffix . :
IP Address. . . . . . . . . . . . : 10.0.0.11
Subnet Mask . . . . . . . . . . . : 255.255.255.0
Default Gateway . . . . . . . . . :
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 231
General Reference Guide Appendix
10.4 Resetting the eWON
10.4.1
Overview
In some situation it may be desired or required to initialize the eWON.
The eWON has a non volatile memory which is used to store configurations and acquired data. Non volatile information is basically divided into 2 groups:
• Communication configuration
• The rest of the non volatile data (file system, Tag Config, user defined web site, etc.)
The reset button is located between the SERIAL and LINE connectors. A very small hole is located in the box; you will need a thin tool like a paper clip to push the button.
The button must be pressed while the eWON is powered up. The button must be maintained until correct initialization level has been reached
(see below):
User led
Reset hole
Figure 157: eWON - reset hole and "USER" led
10.4.2
Reset sequence
There are 2 initialization levels:
• The first level (the more usual) will force a format of the eWON.
• The second level will reset the eWON in a state corresponding to the "out of the box" configuration. By doing this you will also perform a thorough self test of the eWON.
10.4.2.1
First level reset
When the eWON boots with the reset button pressed, after few seconds, the "USER" led will start blinking in red at a 1 flash per second rate. As soon as the led starts blinking at that rate, release the switch. The Format request will be set.
The blinking will continue during 4 seconds, after the eWON will enter in “Second level reset” (see next paragraph), so there is no need to hurry, but you must release the switch before the 4 seconds elapse.
10.4.2.2
Second level reset
If the reset button is maintained for more than 4 seconds (wait 15 seconds with Firmware prior 6.0s3) after blinking starts, the "USER" led will stop blinking and will become solid red, at that moment the "Out of the box reset" is registered, the reset button can be released and all the data of the eWON will be erased, including its communication, IP address,… parameters.
The eWON configuration tool eBuddy will be required to define your eWON working IP address.
Note: if you have waited too long and the "USER" led becomes "solid red" while you only needed to format the eWON, the only solution is to keep the reset button pressed and remove the eWON power, this will avoid entering the "Full Erase" procedure.
10.4.3
Second level initialization diagnostics
When the second level initialization is requested, the eWON will also perform a self test. When the initialization ends, the test result is displayed via the "USER" led. If the test is successful, the following pattern will be displayed on the led.
The led will flash for 200msec every 1.5 seconds. The pattern is repeated indefinitely until the eWON is manually rebooted (Power OFF/Power
ON).
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 232
General Reference Guide
If an error is detected during the test, the led will show the error code with the following pattern:
Appendix
1 sec.
Error pattern for code = 2
This example shows error code 2. The pattern is repeated indefinitely until the eWON is manually rebooted (power OFF/Power ON).
The pattern starts with a short blink of 200msec indicating the pattern start, then N blinks, each during 1 second are displayed. Then the pattern is repeated, etc.
The number of 1 second blinks is defined by the type of error detected:
Number of blinks
1
2
3
4
5
6
Error meaning
RAM Test error
Flash erase error
Flash write error
Real Time Clock error
Flash identification failed
IO CPU not responding
Table 204: eWON USER led blinks meaning
10.4.4
Reset of the eWON Flexy
The reset button BI1 is located on the right side of the eWON Flexy (see picture, more information in the Installation Guide IG-014-0-EN).
In the LED array on the left side of the eWON Flexy, the LED labelled BI1 goes ON when the reset button BI1 is pressed. The basic principle of reset level 1 and 2 are applying the same way to the Flexy family. There are some specifics though, mainly in timing.
• Time to reach the first level LED status (flashing RED): approximately 30 seconds
• Time to reach the second level LED status (RED steady): approximately 35 sceonds
• Time to perform the level 2 reset and autotest itself: approximately 2 seconds
As for the other eWONs, the Flexys do restart on their own after a level 1 reset but need to be rebooted afer a level 2 reset.
10.4.5
Entering level 2 initialization without request
The eWON may enter level 2 test without request in the following case:
• If the IO CPU is not responding at boot time
In that special case you may detect the typical led blinking of the level 2 initialization, without having requested that mode. Just reboot the unit (power if OFF and ON again).
10.4.6
What to do in case of error?
If an error is detected during the self test, run the test again to confirm the result. If test error persists, your local reseller to organize a factory return and repair.
10.4.7
Important remark
When performing a level 2 self test, it is important to let the test run until the end, if you stop the test before the end, the flash memory may contain random data that may cause unexpected operation of the eWON when it starts. For this reason, the self test procedure after a level 2 reset should
NOT be interrupted until the "USR" led displays the test result.
Note: This process can take up to 10 minutes except on the eWON Flexy where performing a level 2 reset takes only 2 seconds, self test included. In case if trouble, redo a level 2 reset again to return to a normal situation.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 233
General Reference Guide
10.5 Table of comparison between eWON types
10.5.1
Primary & Compact Ranges
10.5.1.1
Hardware features
Appendix
10.5.1.2
Software features
10.5.2
Flexy Range
The tables below show only the primary features of the Base Units. A lot of additional features are available by addition of Extension Cards.
Current examples are Ethernet WAN, modem, serial ports, IO-cards. Please check the Installation Guides of the Flexy range.
10.5.2.1
Hardware features
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 234
10.5.2.2
Software features
General Reference Guide Appendix
10.5.3
Obsolete Types
The products listed below are no longer available but are still supported.
10.5.3.1
Hardware features
10.5.3.2
Software features
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 235
General Reference Guide Appendix
10.6 Duplicate IP detection (User Led blinking Red)
Since firmware 4.3, eWON performs a check on the IP network in order to avoid duplicate IP.
eWON makes this test at power up to see if its IP address is not conflicting with another device.
If eWON is configured with the same IP address than another device, eWON will not start and the USER LED blinks continuously with the following pattern: short red light + pause + long red light + pause
Resolution:
1) Isolate your eWON from the conflicting device
The best way is to use a direct crossed IP cable to directly link your PC with the eWON (without a hub)
2) Reboot the eWON
3) Change the eWON IP address (with eBuddy, you can download from http://support.ewon.biz
When eWON is blocked, the duplicate IP test is made again every 10 minutes. If the conflicting device is not present anymore, then eWON will start normally.
10.7 Rockwell compatibility matrix
This document lists the compatibility matrix between eWON and the Rockwell- Allen Bradley PLC family.
PLC Name/Type
PLC5
SLC500
MicroLogix
CompactLogix
ControlLogix
FlexLogix
EIP x x x x x x
DF1 eWON
Version
Rev 5.1
Comments x x x x x x
Rev 5.3
Rev 5.3
Rev 5.3
DF1 only since Rev 5.3
DF1 only since Rev 5.3
DF1 only since Rev 5.3
Table 205: Rockwell compatibility matrix
IO Server
Name
DF1
DF1
DF1
ABLOGIX
ABLOGIX
ABLOGIX
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 236
.
10.8 GSM modem Led behavior
General Reference Guide Appendix
Figure 158: GSM level display on led
On the Primary and Compact ranges, the modem LED default behavior is to go ON solid green when a PPP-link is established and OFF otherwise. If the option Display Level on LED is selected, the modem LED will display the signal level as described here:
The LED displays 2 types of information:
• whether the modem is connected or not.
• the signal level.
The display pattern has a duration of 8 seconds. The first 4 seconds display the signal level and the last 4 seconds the connection status.
Signal level: the signal level is displayed 4 times. The led goes on between 100msec to 900msec according to the signal level. Then the blink is repeated 3 more times.
Connection state: for the last 4 seconds, the led is ON if connection is established (PPP connection established). The led is OFF if there is no ongoing connection.
Note: the signal level displayed here is a rough indication, the exact level can be read from the modem configuration page in the eWON.Note:
Connected
Low signal level
Connected
High signal level
Disconnected
High signal level
Table 206: GSM Level display patterns
The present § does not apply to the eWON Flexy wireless modem Extension Card. The Flexy wireless modem has 4 status LEDs out of which 1 reflects the online status and 3 reflect the signal level (low, medium, high). The low level LED is ON (green) when the signal level is >1. The medium level LED is ON (green) when the signal level is >10. The high level LED is ON (green) when the signal level is >16. See Installation
Guide IG-019-0-EN.
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 237
General Reference Guide Appendix
10.9 SMS Character set GSM 03.38
Before firmware version 6.4 S1, sending out an SMS using special characters could fail depending on the type of GSM modem which was used inside the eWON.
Since firmware 6.4 S1, eWON now applies the character set GSM 03.38 for all modem types.
Figure 159: GSM 03.38 Basic Character Set
RG-001-1-EN rev. 2.1
eWON® - 14/01/2014 - ©eWON sa Page 238
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Related manuals
advertisement