DSEServicetool Software Manual
DSEServicetool Software Manual
DSEServicetool
PC Software Manual
057-265 ISSUE: 9
DSEServicetool PC Software Manual
E-mail: sales@deepseaelectronics.com
Website: www.deepseaelectronics.com
The DSE logo and the names DSEGenset, DSEATS, DSEPower and DSEControl are UK registered
trademarks of Deep Sea Electronics Ltd.
Any reference to trademarked product names used within this publication is owned by their respective
companies.
Deep Sea Electronics Ltd reserves the right to change the contents of this document without prior
notice.
Revision History
TABLE OF CONTENTS
Section Page
1 INTRODUCTION .................................................................................................. 4
1.1 CLARIFICATION OF NOTATION ............................................................................................ 4
1.2 GLOSSARY OF TERMS .......................................................................................................... 4
1.3 BIBLIOGRAPHY ...................................................................................................................... 5
2 INSTALLATION ................................................................................................... 6
2.1 INSTALL THE PCAN DRIVER ................................................................................................ 6
2.2 SOFTWARE INSTALLATION .................................................................................................. 6
2.2.1 MINIMUM SYSTEM REQUIREMENTS ............................................................................ 6
2.2.2 INSTALLATION OF DSESERVICETOOL PC SOFTWARE ............................................. 6
3 USB-CAN INTERFACE ....................................................................................... 8
3.1 BATCH PROGRAMMING CONNECTIONS FOR DSEM835 .................................................. 9
3.1.1 TYPICAL CONNECTION DIAGRAM .............................................................................. 10
3.1.1.1 EXAMPLE WITH ONLY TWO DEVICES CONNECTED TO THE TEN WAY
HARNESS 10
3.1.2 PARTS LIST .................................................................................................................... 11
4 USING THE DSESERVICETOOL PC SOFTWARE .......................................... 12
4.1 STARTING DSESERVICETOOL SOFTWARE ..................................................................... 12
4.2 PREPARING THE DEVICE FOR CONNECTION .................................................................. 12
4.2.1 BOOTLOADER MODE .................................................................................................... 12
4.2.2 DSEM240 ........................................................................................................................ 13
4.2.3 DSEM640 & DSEM643 ................................................................................................... 13
4.2.4 DSEM835 ........................................................................................................................ 14
4.2.4.1 CONNECTION FROM PC TO A SINGLE DSEM835 DEVICE ................................ 14
4.2.4.2 CONNECTION FROM PC TO MULTIPLE DSEM835 DEVICES ............................ 15
4.2.5 DSEM840 ........................................................................................................................ 16
4.2.6 DSEM870 / DSEM871 ..................................................................................................... 17
4.2.7 DSEM812 ........................................................................................................................ 18
4.3 SEARCHING FOR DEVICES ................................................................................................. 19
4.3.1 FAILED TO INITIALISE CAN .......................................................................................... 20
4.3.2 NO MODULES FOUND .................................................................................................. 20
4.3.3 DEVICES FOUND ........................................................................................................... 21
4.3.3.1 CAN CONNECTED DEVICES ................................................................................. 21
4.3.3.2 ETHERNET CONNECTED DEVICES ..................................................................... 21
4.4 BASIC ..................................................................................................................................... 22
4.4.1 DSEM240 ........................................................................................................................ 22
4.4.2 DSEM640, DSEM643, DSEM840, DSEM870, DSEM871, & DSEM812 ........................ 22
4.4.3 DSEM835 ........................................................................................................................ 23
4.4.4 PARAMETERS ................................................................................................................ 23
4.5 ADVANCED ........................................................................................................................... 24
4.5.1 PARAMETERS ................................................................................................................ 24
4.6 MODULE INFORMATION ...................................................................................................... 27
4.7 ABOUT ................................................................................................................................... 27
1 INTRODUCTION
DSEServicetool is used to scan local networks (LAN or CAN) connected to the PC for supported
devices manufactured by Deep Sea Electronics Ltd.
DSEServicetool lists the devices found, displaying avaialble network connection information.
This is used to update the firmware and download a program to the device.
For DSEM835 Vx.y onwards, and DSEServicetool Va.b.c onwards, batch programming of up to ten
(10) devices is available. See section entitled Batch Programming Connections for DSEM835
elsewhere in this document.
Term Description
Application Generally produced by the OEM or DSE customer, this code is either CODESYS
or Qt (depending upon device variant).
Bootloader Software within the MSeries device that is executed at device power up. Used to
detection connection to DSEServicetool and handle the update process.
CAN Controller Area Network. Requires to the use of a PC CAN interface as detailed in
the sections entitled DSEM240 and DSEM835 elsewhere in this document.
DSEServicetool Short name for DSEServicetool PC Software.
Firmware Software within the MSeries that handles the execution of the application code.
IP Internet Protocol
Commonly used when describing the ethernet network address of a device (IP
Address).
LAN Local Area Network (Ethernet).
MAC Media Access Control.
A MAC address is a unique identifier code for a network adaptor connected to a
LAN or WAN. The MAC is also used to identifiy the manufacturer of the device.
PCAN PCAN USB interface for PC. Manufactured by https://www.peak-system.com/
Provides a CAN interface to USB enabled PCs. This is used by DSEServicetool to
make connection to support CAN enabled M-Series devices.
UID Unique Identifier. A unique number assigned to each DSE MSeries device.
WAN Wide Area Network.
Usually refers to the World Wide Web of interconnected networks.
1.3 BIBLIOGRAPHY
The following documents area available on the DSE website www.deepseaelectronics.com.
These documents refer to DSE controllers supported by DSEServicetool PC Software.
2 INSTALLATION
2.1 INSTALL THE PCAN DRIVER
You must install the PCAN Driver supplied with the PCAN Interface, or downloaded from
https://www.peak-system.com/
This is required to allow DSEServicetool PC Software to communicate with the PCAN USB device.
This driver must be installed before starting DSEServicetool PC Software. However it can be installed
either before or after the installation of DSEServicetool PC Software.
Operating System Windows 10, Windows 8.1 (Linux support is not provided).
Monitor 17 inch recommended (1024 x 768 resolution)
Communications Ethernet connection (wired or wireless), PCAN interface for CAN supported
CAN enabled devices.
NOTE: Exit all other programs before installing the software. It is recommended that any
earlier releases of the software be uninstalled prior to installing this version.
Continued overleaf…
The computer prompts for selection of where DSEServicetool is to be installed on the PC.
Click Browse to
select another
location to install
to.
After completion,
click Finish to exit
the Setup Wizard.
3 USB-CAN INTERFACE
NOTE: DSE Stock and supply PCAN-USB IPEH-002021. DSE Part number 016-179. Contact
sales@deepseaelectronics.com.
NOTE: Ensure the PCAN USB driver is installed. For details, see section entitled Install
the PCAN Driver elsewhere in this document.
To convert PC USB to CAN Interface, use one of the following devices. Both devices offer the same
basic functionality, with the Opto-Isolated variant providing enhanced protection should there be a
potential difference (up to 500 V) between the Earth points of the CAN device and the PC.
The device driver is supplied with the interface and is further available at the website listed in the table
below.
Connect PCAN-USB to DSEMSeries device using connections for CAN H, CAN L and GND.
For programming a single DSEM835 connection looms are available from DSE, see DSE Publication
057-313 DSEEM835 Operator Manual.
For DSEM835 Batch Programming connections see the following section of this document Batch
Programming Connections for DSEM835 for details how to build your own Batch Programming Loom
for use in the production environment.
NOTE: Batch programming feature is available only for DSEM835 with Bootloader V1.1.0
onwards. Devices with earlier Bootloader versions cannot be field updated to a later
Bootloader version. DSEServicetool V1.46.3 or later is required.
NOTE: Batch Programming connection length must be as short as possible to meet the
needs of the production environment. Absolute Maximum Overall Length of the CAN
connection is 40 m (43.7 yards). Excessive length slows transmission and causes
transmission failure.
NOTE: Screened 120 impedance cable specified for use with CAN must be used for the
CAN links.
DSE stock and supply Belden cable 9841 which is a high quality 120 impedance cable
suitable for CAN use (DSE part number 016-030).
NOTE: CAN connections are NOT internally terminated. A complete CAN network must
have 120 Ω terminators at each end of the network.
NOTE: Where less than 10 devices are connected to the loom, remember to add the
termination resistor to Pins A3 and A4 of the first unused plug !
Additionally, as the loom relies on the M835 internal connection from A3 to A9 and A4 to A10,
the plug closest to the 9-way connector MUST be used for device 1, then there must be no
unconnected plugs between first and last used plug in the loom.
For batch programming up to ten (10) devices are supported. Connections are as follows.
3.1.1.1 EXAMPLE WITH ONLY TWO DEVICES CONNECTED TO THE TEN WAY HARNESS
NOTE: Ensure the PCAN USB driver is already installed before proceeding. For details,
see section entitled Install the PCAN Driver elsewhere in this document.
NOTE: Ensure the DSEMxxx device is correctly connected and in the bootloader mode
during discovery. Devices not in bootloader mode are not discovered by the scan.
Upon loading, the DSEServicetool automatically performs a search and finds connected devices.
4.2.2 DSEM240
NOTE: Ensure no other devices are connected to the CAN during DSEServicetool
operation. This ensures the CAN traffic is minmised, allowing for the extra traffic during
transfer and ensures other devices are not affected.
NOTE: For CAN connection details see section entitled USB-CAN Interface elsewehere in
this document.
Connection is by CAN.
NOTE: Ensure no other devices are connected to the CAN during DSEServicetool
operation. This ensures the CAN traffic is minmised, allowing for the extra traffic during
transfer and ensures other devices are not affected.
NOTE: DSEM640 / DSEM643 Connection by CAN is supported from V2.0 onwards and
requires the device to be configured to use one CAN port for Download. For further details see
DSE Publication 057-244 DSEM640 & DSEM643 Operator Manual.
NOTE: CAN connection is considerably slower than Ethernet. File transfer by Ethernet is
recommended where possible.
NOTE: For CAN connection details see section entitled USB-CAN Interface elsewehere in
this document.
4.2.4 DSEM835
NOTE: Ensure no other devices are connected to the CAN during DSEServicetool
operation. This ensures the CAN traffic is minmised, allowing for the extra traffic during
transfer and ensures other devices are not affected.
NOTE: For CAN connection details and/or Batch Programming details, see section entitled
USB-CAN Interface elsewehere in this document.
NOTE: Batch programming feature is available only for DSEM835 with Bootloader V1.1.0
onwards. Devices with earlier Bootloader versions cannot be field updated to a later
Bootloader version. DSEServicetool V1.46.3 or later is required.
Connection is by CAN.
NOTE: Ensure no other devices are connected to the CAN during DSEServicetool
operation. This ensures the CAN traffic is minmised, allowing for the extra traffic during
transfer and ensures other devices are not affected.
NOTE: For CAN connection details and/or Batch Programming details, see section entitled
USB-CAN Interface elsewehere in this document.
NOTE: Batch programming feature is available only for DSEM835 with Bootloader V1.1.0
onwards. Devices with earlier Bootloader versions cannot be field updated to a later
Bootloader version. DSEServicetool V1.46.3 or later is required.
Connection is by CAN to up to ten (10) DSEM835 devices.
• Remove DC Power from all DSEM835s. A single DC power switch is the most suitable way to
achieve this.
• Right-Click (CODESYS Gateway) in the Windows System Tray. Select Stop Gateway. This
disconnects CODESYS from the PCAN USB driver for use with DSEServicetool.
• Connect DSEM835s to the Batch Programming harness and in turn connect this to the PCAN
USB interface.
• Click on the DSEServicetool underneath Select Connection Method.
• Apply DC Power to all DSEM835s . A single DC power switch is the most suitable way to
achieve this.
• All DSEM835s display confirmation of bootloader mode (Version number may differ. ID differs
between devices.)
• Any device not showing the Bootloader message was not found in the scan. Check
connections and retry the scan, otherwise continue to program all devices that were found,
and correctly show the Bootloader message.
• Upon completion of using DSEServicetool to service the DSEM835, Close DSEServicetool,
Right-Click (CODESYS Gateway) in the Windows System Tray. Select Start Gateway. This
reconnects CODESYS to the PCAN USB driver.
4.2.5 DSEM840
Connection is by Ethernet.
Connection is by Ethernet.
Continued Overleaf.
• The device is now in the correct state and is discoverable by the DSEServicetool Scan
function.
4.2.7 DSEM812
Connection is by Ethernet.
• The device is now in the correct state and is discoverable by the DSEServicetool Scan
function.
NOTE: When connecting by CAN it may be necessary to first stop the CODESYS Gateway:
Right-Click (CODESYS Gateway) in the Windows System Tray and select Stop Gateway.
This disconnects CODESYS from the PCAN USB driver for use with DSEServicetool.
Upon completion of using DSEServicetool to service the device, Close DSEServicetool, Right-
Click (CODESYS Gateway) in the Windows System Tray and select Start Gateway. This
reconnects CODESYS to the PCAN USB driver.
NOTE: Batch programming feature is available only for DSEM835 with Bootloader V1.1.0
onwards. Devices with earlier Bootloader versions cannot be field updated. DSEServicetool
V1.46.3 or later is required.
To connect with DSEM640, DSEM643 you may select either Ethernet, or CAN depending upon
configuration of the device. Connection by CAN requires prior enabling of the CAN port. For further
details, see DSE Publication 057-244 DSEM640 / DSEM643 Operator Manual.
To connect with DSEM840, M870 and DSEM812, click Ethernet to search the network for devices
(connection by CAN is not supported).
To connect with DSEM240. click CAN (this device does not include Ethernet connectivity).
To connect with DSEM835, click CAN to scan for a single device or up to ten (10) devices connected
by the Batch Programming Harness.
Before searching for devices, DSEServicetool initialises the CAN (PCAN USB). In case of error, the
following message is shown:
NOTE: For CAN devices, ensure the CAN is correctly connected and termination resistors
are fitted. For a single DSEM835, DSE part 016-177 (M835 Programming Harness) includes the
termination resistor as this is intended to be the only connection to the DSEM835.
DSE part 016-176 M835 Connector Harness DOES NOT include the termination resistor as this
may be part of a larger CAN network.
NOTE: Batch programming feature is available only for DSEM835 with Bootloader V1.1.0
onwards. Devices with earlier Bootloader versions cannot be field updated to a later
Bootloader version. DSEServicetool V1.46.3 or later is required.
NOTE: For Ethernet devices, ensure the device is on the same subnet as the PC. For
further details consult your IT Network Manager.
When no DSE devices are detected on the network, the DSEServicetool issues a warning message :
Check connections including cable type and the presence of CAN termination resistors, and ensure
the device to connect with is in the Bootloader mode.
After clicking OK, click the button to repeat the scan.
Where devices are found using CAN, the Basic page is automatically displayed. See section entitled
Basic for further details.
When DSE devices are connected to the ethernet network, the DSEServicetool software displays the
type and number of devices detected. To connect, select the required device type. After selection the
Basic page is automatically displayed. See section entitled Basic for further details.
4.4 BASIC
NOTE: If the transferred file is not suitable for the connected device (ie incorrect firmware
version), DSEServicetool will not warn. Simply the device fails to install the file.
NOTE: File transfer is not possible with DSEM870 V1 and V2 devices. The firmware must
be updated to ensure full compatibility with DSEServicetool.
This section shows basic information and allows a package file to be transferred to the DSE device.
For other feature, see section entitled Advanced elsewhere in this document.
4.4.1 DSEM240
4.4.3 DSEM835
4.4.4 PARAMETERS
Option Description
Choose Package Browse to select the package file to be sent to the device. Compatible
packages include bootloader updates (not applicable to DSEM835),
firmware updates and application software.
To create an application file suitable for transfer (not applicable to
DSEM240), from within CODESYS:
• The file is saved with extension .app suitable for sending to the
target device from DSEServicetool PC Software. For further
details, see the relevant device CODESYS / Operator Manual.
Module IP Address This is the address that is used for the transfer process of the package
Generate IP file.
(Not applicable to CAN If you have already been provided an IP address for the device by the
connections) network manager, enter it here, or enter a unique IP address not already
in use on the connected network.
If an IP address has not yet been assigned, you may click Generate IP to
allow DSEServicetool to temporarliy assign an IP address to the device.
This is used only for the transfer process.
Basic Provides a simplified display without the Transfer Status window.
Module Information Displays the following information about the connected device:
(Not applicable to CAN MAC Address:
connections) UID (Unique Identifier)
Firmware Version
Bootloader Version
Recovery File Version
Rescan for Controllers Restarts the scan process to look for newly connected devices.
About Displays version information for DSEServicetool PC Software.
4.5 ADVANCED
NOTE: File transfer is not possible with DSEM870 V1 and V2 devices. The firmware must
be updated to ensure full compatibility with DSEServicetool.
NOTE: If the transferred file is not suitable for the connected device (ie incorrect firmware
version), DSEServicetool will not warn. Simply the device fails to install the file.
Designed for advanced users, this section shows the status of the connected device and the transfer
progress after downloading a package file.
Shows the
MAC Click to download the
address of selected package file
the to the DSE device.
connected
DSE device.
4.5.1 PARAMETERS
Option Description
Choose Package Browse to select the package file to be sent to the device. Compatible
packages include bootloader updates (not applicable to DSEM835),
firmware updates and application software.
To create an application file suitable for transfer (not applicable to
DSEM240), from within CODESYS:
The file is saved with extension .app suitable for sending to the target
device from DSEServicetool PC Software. For further details, see the
relevant device CODESYS / Operator Manual.
Module IP Address This is the address that is used for the transfer process of the package file.
Generate IP If you have already been provided an IP address for the device by the
network manager, enter it here, or enter a unique IP address not already in
use on the connected network.
Alternatively, If an IP address has not yet been assigned, you may click
Generate IP to allow DSEServicetool to temporarliy assign an IP address
to the device. This address is used only for the transfer process.
Basic Provides a simplified display without the Transfer Status window.
Option Description
Module Information Displays the following information about the connected device:
MAC Address
UID (Unique Identifier)
Firmware Version
Bootloader Version
Recovery File Version
Rescan for Controllers Restarts the scan process to look for newly connected devices.
Erase Application Removes the CODESYS Application.
(DSEM835 Only)
Erase Settings Erases the non-voltatile memory which removes Persistent Variables from
(DSEM835 Only) the device and sets Device Settings back to factory settings, including CAN
baudrate to 250 kbit/s.
About Displays version information for DSEServicetool PC Software. When
visible, click the window to close it and return to the main program.
Download Transfers the file to the device. See overleaf for an example image of the
Transfer Progress window.
Transfer Status shows file transfer progress at the end of the package download.
A message is displayed at the end of the package transfer. Power cycling of the module must only be
performed after the module’s LED turns off.
NOTE: If the transferred file is not suitable for the connected device (ie incorrect firmware
version), DSEServicetool will not notify. ‘Transfer Successful’ is displayed, however the device
fails to install the file.
This section is designed to show hardware, firmware and bootloader version information of the
connected DSE device.
4.7 ABOUT
This section shows the current version of the DSEServicetool PC Software. Click anywhere in the
About box to remove it and return to the main application.