ADF Web HD67E17-A1 User manual

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 1 of 31
User Manual
Revision 1.000
En lish
EtherCAT / MQTT - Converter
(Order Code: HD67E17-A1)
For Website information:
www.adfweb.com?Product=HD67E17
For Price information:
www.adfweb.com?Price=HD67E17-A1
Benefits and Main Features:
Very easy to confi ure
Triple Electrical isolation
Temperature ran e: -40°C/+85°C (-40°F/+185°F)
For other EtherCAT Slave products see also the followin link:
Converter EtherCAT Slave to
www.adfweb.com?Product=HD67E00 (Serial)
www.adfweb.com?Product=HD67E01 (Modbus Master)
www.adfweb.com?Product=HD67E02 (Modbus Slave)
www.adfweb.com?Product=HD67E03 (Modbus TCP Master)
www.adfweb.com?Product=HD67E04 (Modbus TCP Slave)
www.adfweb.com?Product=HD67E05 (BACnet Master)
www.adfweb.com?Product=HD67E06 (BACnet Slave)
www.adfweb.com?Product=HD67E07 (CA )
www.adfweb.com?Product=HD67E08 (CA open)
www.adfweb.com?Product=HD67E09 (Device et Master)
www.adfweb.com?Product=HD67E10 (Device et Slave)
www.adfweb.com?Product=HD67E11 (DMX)
www.adfweb.com?Product=HD67E12 (Ethernet)
www.adfweb.com?Product=HD67E14 (IEC61850 Master)
www.adfweb.com?Product=HD67E15 (IEC61850 Server)
www.adfweb.com?Product=HD67E16 (J1939)
www.adfweb.com?Product=HD67E18 ( MEA0183)
www.adfweb.com?Product=HD67E19 ( MEA2000)
www.adfweb.com?Product=HD67E20 (OPC UA Client)
www.adfweb.com?Product=HD67E21 (OPC UA Server)
www.adfweb.com?Product=HD67E22 (PROFI ET Master)
www.adfweb.com?Product=HD67E23 (PROFI ET Slave)
www.adfweb.com?Product=HD67E24 (S MP Manager)
www.adfweb.com?Product=HD67E25 (S MP Agent)
www.adfweb.com?Product=HD67E26 (Ether et/IP Master)
www.adfweb.com?Product=HD67E27 (Ether et/IP Slave)
www.adfweb.com?Product=HD67E28 (S7comm Client)
www.adfweb.com?Product=HD67879 (IO-Link Master)
User Manual

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 2 of 31
I DEX:
Pa e
INDEX 2
UPDATED DOCUMENTATION 2
REVISION LIST 2
WARNING 2
TRADEMARKS 2
SECURITY ALERT 3
EXAMPLE OF CONNECTION 4
CONNECTION SCHEME 5
CHARACTERISTICS 6
CONFIGURATION 6
POWER SUPPLY 7
FUNCTION MODES 8
LEDS 9
ETHERCAT 10
ETHERNET 11
USE OF COMPOSITOR SW67E17 12
NEW CONFIGURATION / OPEN CONFIGURATION 13
SOFTWARE OPTIONS 14
SET COMMUNICATION 16
ETHERCAT SET ACCESS 21
MQTT SET TOPIC 23
ETHERCAT ESI FILE 24
UPDATE DEVICE 25
TEMPLATE STRING: DEFINITION OF MQTT
PAYLOAD
27
MECHANICAL DIMENSIONS 28
ORDERING INFORMATIONS 29
ACCESSORIES 29
DISCLAIMER 30
OTHER REGULATIONS AND STANDARDS 30
WARRANTIES AND TECHNICAL SUPPORT 31
RETURN POLICY 31
UPDATED DOCUME TATIO :
Dear customer, we thank you for your attention and we remind you that
you need to check that the followin document is:
Updated
Related to the product you own
To obtain the most recently updated document, note the “document code”
that appears at the top ri ht-hand corner of each pa e of this document.
With this “Document Code” o to web pa e www.adfweb.com/download/
and search for the correspondin code on the pa e. Click on the proper
“Document Code” and download the updates.
REVISIO LIST:
WAR I G:
ADFweb.com reserves the ri ht to chan e information in this manual about
our product without warnin .
ADFweb.com is not responsible for any error this manual may contain.
TRADEMARKS:
All trademarks mentioned in this document belon to their respective
owners.
Revision Date Author Chapter Description
1.000 18/09/2020 Ff All First Release

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 3 of 31
SECURITY ALERT:
G E ERAL I FORMATIO
To ensure safe operation, the device must be operated accordin to the instructions in the manual. When usin the device, le al and
safety re ulation are required for each individual application. The same applies also when usin accessories.
I TE DED U SE
Machines and systems must be desi ned so the faulty conditions do not lead to a dan erous situation for the operator (i.e.
independent limit switches, mechanical interlocks, etc.).
Q UALIFIED P ERSO EL
The device can be used only by qualified personnel, strictly in accordance with the specifications.
Qualified personnel are persons who are familiar with the installation, assembly, commissionin and operation of this equipment and
who have appropriate qualifications for their job.
R ESIDUAL R ISKS
The device is state-of-the-art and is safe. The instruments can represent a potential hazard if they are inappropriately installed and
operated by untrained personnel. These instructions refer to residual risks with the followin symbol:
This symbol indicates that non-observance of the safety instructions is a dan er for people that could lead to serious injury or
death and / or the possibility of dama e.
CE CO FORMITY
The declaration is made by our company. You can send an email to [email protected]om or ive us a call if you need it.

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 4 of 31
EXAMPLE OF CO ECTIO :

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 5 of 31
CO ECTIO SCHEME:
Figure 1: Connection scheme for HD67E17-A1

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 6 of 31
CHARACTERISTICS:
The HD67E17-A1 are EtherCAT / MQTT - Converters.
It allows for the followin characteristics:
Isolation between EtherCAT – MQTT – Power Supply;
Two-directional information between EtherCAT bus and MQTT bus;
Mountable on 35mm Rail DIN;
Wide power supply input ran e: 8…24V AC or 12…35V DC;
Wide temperature ran e: -40°C / 85°C [-40°F / +185°F].
CO FIGURATIO :
You need Compositor SW67E17 software on your PC in order to perform the followin :
Define the parameters of EtherCAT line;
Define the parameters of MQTT line;
Define EtherCAT variables to read and write;
Define the list of MQTT topics to publish/subscribe to the server;
Export the ESI file for confi uration of EtherCAT Master;
Update the device.

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 7 of 31
POWER SUPPLY:
The devices can be powered at 8…24V AC and 12…35V DC. For more details see the two tables below.
VAC
VDC
Vmin Vmax Vmin Vmax
8V 24V 12V 35V
Consumption at 24V DC:
Device Consumption [W/VA]
HD67E17-A1 3.5
HD67E17-A1
Caution:
Do n
ot reverse the polarity power

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 8 of 31
FU CTIO MODES:
The device has ot two function modes dependin on the position of the ‘Dip1 of Dip-Switch A’:
The first, with ‘Dip1 of Dip-Switch A’ at “OFF” position, is used for the normal workin of the device.
The second, with ‘Dip1 of Dip-Switch A’ at “ON” position, is used for uploadin the Project and/or Firmware.
For the operations to follow for the updatin , see ‘UPDATE DEVICE’ section.
Accordin to the functionin mode, the LEDs will have specific functions, see ‘LEDS’ section.

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 9 of 31
LEDS:
The device has ot seven LEDs that are used to ive information about the functionin status.
The various meanin s of the LEDs are described in the table below.
LED ormal Mode Boot Mode
1: Device State ( reen) Blinks slowly (~1Hz) Blinks quickly: Boot state
Blinks very slowly (~0.5Hz): update in pro ress
2: EtherCAT comm. ( reen) It blinks when EtherCAT communication is runnin Blinks quickly: Boot state
Blinks very slowly (~0.5Hz): update in pro ress
3: MQTT comm. ( reen) It blinks when MQTT communication is runnin Blinks quickly: Boot state
Blinks very slowly (~0.5Hz): update in pro ress
4: Error state ( reen) O : An error in the communication busses occurs
OFF: No errors are present
Blinks quickly: Boot state
Blinks very slowly (~0.5Hz): update in pro ress
5: EtherCAT state ( reen)
OFF: EtherCAT Master not connected
Blinking: EtherCAT Master is connectin
O : EtherCAT Master is connected
Blinks quickly: Boot state
Blinks very slowly (~0.5Hz): update in pro ress
6: Ethernet1 link ( reen) O : Ethernet cable connected
OFF: Ethernet cable disconnected
O : Ethernet cable connected
OFF: Ethernet cable disconnected
7: Ethernet2 link ( reen) O : Ethernet cable connected
OFF: Ethernet cable disconnected
O : Ethernet cable connected
OFF: Ethernet cable disconnected

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 10 of 31
ETHERCAT
EtherCAT (Ethernet for Control Automation Technolo y) is an Ethernet-based fieldbus system, invented by Beckhoff Automation.
The protocol is standardized in MQTT and is suitable for both hard and soft real-time computin requirements in automation technolo y.
With EtherCAT, the standard Ethernet packet or frame (accordin to IEEE 802.3) is no lon er received, interpreted, and copied as process
data at every node. The EtherCAT slave devices read the data addressed to them while the tele ram passes throu h the device, processin
data "on the fly". In other words, real-time data and messa es are prioritized over more eneral, less time-sensitive or heavy load data.
The converter has two EtherCAT ports, one is used as Input port (Connector7) and it will receive the incomin messa es from the Master,
the other is used as Output port (Connector8) and i twill forward the messa es to the others nodes of the network.

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 11 of 31
ETHER ET:
The Ethernet port is used for pro rammin the device and for MQTT communication.
Ethernet connection and the updatin of the converter must be made usin Connector9 and/or Connector10 of the HD67E17-A1 with at least
a Cate ory 5E cable. The maximum len th of the cable should not exceed 100m. The cable has to conform to the T568 norms relative to
connections in cat.5 up to 100 Mbps. To connect the device to an Hub/Switch is recommended the use of a strai ht cable, to connect the
device to a PC/PLC/other is recommended the use of a cross cable.

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 12 of 31
USE OF COMPOSITOR SW67E17:
To confi ure the Converter, use the available software that runs with Windows called SW67E17. It is downloadable on the site
www.adfweb.com and its operation is described in this document. ( his manual is referenced to the last version of the software present on
our web site). The software works with MSWindows (XP, Vista, Seven, 8, 10; 32/64bit).
When launchin the SW67E17, the window below appears (Fi . 2).
Note:
It is necessary to have installed .Net Framework 4.
F
igure 2: Main window for SW67E1
7

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 13 of 31
EW CO FIGURATIO / OPE CO FIGURATIO :
The “ ew Configuration” button creates the folder which contains the entire device’s confi uration.
A device’s confi uration can also be imported or exported:
To clone the confi urations of a pro rammable “EtherCAT / MQTT - Converter” in order
to confi ure another device in the same manner, it is necessary to maintain the folder
and all its contents;
To clone a project in order to obtain a different version of the project, it is sufficient to
duplicate the project folder with another name and open the new folder with the
button “Open Configuration”.

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 14 of 31
SOFTWARE OPTIO S:
By pressin the “Settings” ( ) button there is the possibility to chan e the lan ua e of the software and check the updatin s for the
compositor.
In the section “Lan ua e” it is possible to chan e the lan ua e of the
software.
In the section “Connection Options”, it is possible to check if there are some
updatin s of the software compositor in ADFweb.com website.
Checkin the option “Check Software Update at Start of Program”, the
SW67E17 checks automatically if there are updatin s when it is launched.

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 15 of 31
In the section “Software Settin s”, it is possible to enable/disable some
keyboard’s commands for an easier navi ation inside the tables contained in
the different sections of the software.

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 16 of 31
SET COMMU ICATIO :
This section define the fundamental communication parameters of two buses, EtherCAT and
MQTT.
By Pressin the “Set Communication” button from the main window for SW67E17 (Fi . 2)
the window “Set Communication” appears (Fi . 3).
The window is divided in different sections in order to define the different parameters of the
converter:
EtherCAT Slave
MQTT
Ethernet
Wi-Fi
TLS (Transport Layer Security)
NTP (Network Time Protocol)
Figure 3a: “Set Communication” window

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 17 of 31
Figure 3c: “Set Communication  MQ ” window
E THER CAT S LAVE :
This section is used to define the eneral parameters of EtherCAT. The means of the
fields are:
In the field “Revision umber” the revision number of the converter is defined;
In the field “Slave ame” the name of the converter is defined;
In the field “ ode Address” the ID of the converter is defined.
M QTT :
This section is used to define the main parameters of MQTT line. The means of the
fields are:
In the field “Server URL” the URL or the IP Address of the MQTT Server is
defined;
In the field “Server Port” the port used for MQTT communication is defined;
In the field “Client ID” the Client ID of the converter is defined (if ned);
In the field “Keep Alive (seconds)” the delay with which the Keep Alive
messa e is sent on MQTT is defined;
If the field “Clean Session” is checked, the last MQTT messa es are deleted by
the Server and the Client in case of missin ACK. If unchecked, the Server and
the Client hold the last MQTT messa es and, in case of incorrect disconnection
or missin ACK, they try to send a ain them since all the ACK messa es are
exchan ed correctly (valid only for QoS 1 and QoS 2);
If the field “Will Flag” is checked, the converter will publish the Will topic at the connection to the Server. With this feature, in case
of incorrect disconnection, the Server will publish this topic to all the MQTT Clients that subscribed it;
In the field “Topic ame Will” the topic used for Will messa e is defined;
In the field “Message Will” the payload of the Will messa e is defined;
In the field “Retained Will” the converter will send the Will messa e with Retain fla enabled. In this way, the Server will hold the
last Will messa e;
In the field “QoS Will” the QoS type for Will messa e is defined;
Im the field “Username” the username for the connection to the MQTT server is defined;
In the field “Password” the password for the connection to the MQTT server is defined.
Figure 3b: “Set Communication  EtherCA Slave”
window

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 18 of 31
Figure 3d: “Set Communication  Ethernet”
window
Figure 3
e
: “Set Communication

Wi
-
Fi” window
E THER ET :
This section is used to define the eneral parameters of Ethernet. The means of the
fields are:
In the field “Ip Address” the IP address of the converter is defined;
In the field “Sub et Mask” the Subnet Mask of the converter is defined;
In the field “Gateway” the default ateway of the net is defined. This feature
can be enabled or disabled pressin the Check Box field. This feature is used
for oin out of the net;
In the field “D S” the DNS address is defined. This field is required if the
server address is define by URL and not IP Address.
W I -F I :
This section is used to define the eneral parameters of Wi-Fi. It is possible to defined
the type of Wi-Fi communication:
Access Point;
Client.
The means of the fields for Access Point confi uration are:
In the field “IP Address” the IP address of the converter is defined;
In the field “Subnet Mask” the SubNet Mask of the converter is defined;
In the field “GATEWAY” the default ateway of the net is defined. This feature
can be enabled or disabled pressin the Check Box field. This feature is used
for oin out of the net;
In the field “D S” the DNS address is defined. This field is required if the
server address is define by URL and not IP Address.
In the field “Port” the port used for MQTT communication is defined;
In the field “SSID” the name of the Wi-Fi network to create is defined;
In the field “Password” the password used for Wi-Fi connection is defined;
In the field “Type” the type of security protocol used by the Wi-Fi network is defined;

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 19 of 31
Figure 3
f
: “Set Communication

Wi
-
Fi” window
If the field “Enable DHCP” is checked, the converter acts as DHCP Server for the Clients connected. If the option is enabled, in the
fields “DHCP First IP Address” and “DHCP SUB ET Mask” the IP Addresses ran e used for DHCP is defined. In the field “Lease
Time (seconds)” the required time for the renewin of the IP Address assi ned to the Client is defined;
In the field “Max Client” the maximum number of Wi-Fi Clients accepted is defined;
In the field “Channel” the channel for Wi-Fi communication is defined.
The means of the fields for Client confi uration are:
If the field “Obtain an IP Address automatically” is checked, the converter
ets the IP Address usin DHCP. Otherwise, the IP Address is defined as
static;
In the field “IP Address” the IP address of the converter is defined;
In the field “Subnet Mask” the SubNet Mask of the converter is defined;
In the field “GATEWAY” the default ateway of the net is defined. This
feature can be enabled or disabled pressin the Check Box field. This feature
is used for oin out of the net;
In the field “D S” the DNS address is defined. This field is required if the
server address is define by URL and not IP Address.
In the field “Port” the port used for MQTT communication is defined;
In the field “SSID” the name of the Wi-Fi network to connect is defined;
In the field “Password” the password used to connect to the Wi-Fi network is
defined.

Industrial Electronic Devices
ADFweb.com S.r.l.
User Manual
EtherCAT
/
MQTT
Document code: MN67E17_ENG Revision 1.000 Pa e 20 of 31
Figure 3g: “Set Communication  LS” window
Figure 3
h
: “Set Communication

N P
” window
T LS :
This section is used to define the parameters of TLS protocol. The means of the fields
are:
If the field “Enable TLS” is checked, the TLS protocol for secure connection is
enabled;
If the field “Server Authentication” is checked, the authentication of the Server
usin TLS is enabled. If enabled, in the field “Server Certificate” the certificate
from the Server is defined;
If the field “Client Authentication” is checked, the authentication of the Client
usin TLS is enabled. If enabled:
oin the field “Client Certificate” the certificate from the Client is defined;
oin the field “Client Key” the private key of the Client is defined;
oin the field “Client Key Password” the password for the private key of the
Client is defined.
TP ( ETWORK T IME P ROTOCOL ):
This section is used to define the parameters of NTP protocol. The means of the fields
are:
In the field “Server URL” the URL or the IP Address of the NTP Server is
defined;
In the field “Poll Time (seconds)” the pollin time for the time synchronization
is defined.