HMS IXXAT simplyCAN User Manual
ssiimmppllyyCCAANN
UUSSBB--ttoo--CCAANN AAddaapptteerr
USER MANUAL
4.01.0001.22001 1.0 en-US ENGLISH
Important User Information
Liability
Every care has been taken in the preparation of this document. Please inform HMS Industrial Networks of any
inaccuracies or omissions. The data and illustrations found in this document are not binding. We, HMS Industrial
Networks, reserve the right to modify our products in line with our policy of continuous product development. The
information in this document is subject to change without notice and should not be considered as a commitment by
HMS Industrial Networks. HMS Industrial Networks assumes no responsibility for any errors that may appear in this
document.
There are many applications of this product. Those responsible for the use of this device must ensure that all the
necessary steps have been taken to verify that the applications meet all performance and safety requirements
including any applicable laws, regulations, codes, and standards.
HMS Industrial Networks will under no circumstances assume liability or responsibility for any problems that may
arise as a result from the use of undocumented features, timing, or functional side effects found outside the
documented scope of this product. The effects caused by any direct or indirect use of such aspects of the product
are undefined, and may include e.g. compatibility issues and stability issues.
The examples and illustrations in this document are included solely for illustrative purposes. Because of the many
variables and requirements associated with any particular implementation, HMS Industrial Networks cannot assume
responsibility for actual use based on these examples and illustrations.
Intellectual Property Rights
HMS Industrial Networks has intellectual property rights relating to technology embodied in the product described in
this document. These intellectual property rights may include patents and pending patent applications in the USA
and other countries.
simplyCAN User Manual
4.01.0001.22001 1.0 en-US
Table of Contents
Page
1 User Guide ........................................................................................................................... 3
1.1 Target Audience......................... ............ ..........................................................................3
1.2 Document History ..................................... ............................... ............ ............................3
1.3 Trademark Information ............... ............ ............................... ............ ...............................3
1.4 Conventions..................................................................... ............ ............................... ....4
2 Safety Instructions .............................................................................................................. 5
2.1 Information on EMC ....................... ............ ................... ............ ............................... ........ 5
2.2 General Safety Instructions....... ............................... ............ ............................... ............ ... 5
2.3 Intended Use.................................................................. ............................... ............ ...... 5
3 Scope of Delivery ................................................................................................................ 5
4 Product Description ............................................................................................................ 6
5 Installation........................................................................................................................... 7
6 Operation............................................................................................................................. 8
6.1 simplyCAN Bus Monitor .............................................................................. ............ .......... 8
6.2 USB LED .................... ............ ................................................................... ............ .......... 9
6.3 CAN LED .......... ............ ............................... ............ ............................... ............ ............. 9
7 Additional Components .................................................................................................... 10
7.1 CAN Bus Termination.......................................................... ............................... ............ . 10
8 Technical Data ................................................................................................................... 11
9 Troubleshooting ................................................................................................................ 11
10 Cleaning ............................................................................................................................. 12
11 Support/Return Hardware................................................................................................ 12
11.1 Support ............................. ............ ............................... ............ ............................... ..... 12
11.2 Return Hardware .............................................. ............................... ............ .................. 12
simplyCAN User Manual
4.01.0001.22001 1.0 en-US
12 Disposal.............................................................................................................................. 12
13 API Documentation ........................................................................................................... 13
13.1 API Functions ... ............ ............................... ............ ............................... ............ ........... 13
13.1.1 simply_open .. . . ...... . . . ...... . . . ...... . . . ...... . . . ..... . . . . ..... . . . ...... . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ... 13
13.1.2 simply_close .. . . . ...... . . . ..... . . . . ...... . . ...... . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ..... . . . . ..... . . . ...... . . . ... 13
13.1.3 simply_initialize_can...... . . . . ..... . . . ...... . . . ...... . . . ...... . . . ...... . . . ...... . . . ..... . . . . ..... . . . ...... . . . ...... . 13
13.1.4 simply_identify . . . ...... . . ...... . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ...... . . ...... . . . . ..... . . . ...... . . . ...... . . . .. 14
13.1.5 simply_start_can ...... . . ...... . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ..... . . . . ..... . . . ...... . . . . ..... . . . ...... . . . ... 14
13.1.6 simply_stop_can . ...... . . . ..... . . . . ..... . . . ...... . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ..... . . . ...... . . . ...... . . . .. 15
13.1.7 simply_reset_can . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ..... . . . ...... . . . ...... . . . ...... . . . ...... . . . ..... . . . . ..... . . 15
13.1.8 simply_can_status ..... . . . . ..... . . . ...... . . . ...... . . . ...... . . . ...... . . . ..... . . . . ..... . . . ...... . . . ...... . . . ...... . . . . 16
13.1.9 simply_set_filter . . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ...... . . ...... . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ...... . 17
13.1.10 simply_receive. ...... . . . ...... . . . ...... . . . ...... . . . ..... . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ...... . . . ..... . . . . .... 18
13.1.11 simply_send. . ...... . . . ..... . . . . ...... . . ...... . . . . ..... . . . ...... . . . ...... . . . ...... . . . ...... . . . ...... . . . ..... . . . . ..... . 18
13.1.12 simply_get_last_error .. . . . . ..... . . . ...... . . . . ..... . . . ...... . . . ...... . . . ..... . . . . ...... . . ...... . . . . ..... . . . ...... . . . 19
13.2 State Diagram................................ ................................................................... ............ . 20
A Regulatory Compliance..................................................................................................... 21
A.1 EMC Compliance (CE) .. ............................................................................... ............ ........ 21
A.2 Disposal and recycling........................ ............ ............................... ............ ...................... 21
simplyCAN User Manual
4.01.0001.22001 1.0 en-US
User Guide 3 (22)
1 User Guide
Please read the manual carefully. Make sure you fully understand the manual before using the
product.
1.1 Target Audience
This manual addresses trained personnel who are familiar with CAN and the applicable standards.
The contents of the manual must be made available to any person authorized to use or operate
the product.
1.2 Document History
Version
1.0
Date
March 2019 First release
1.3 Trademark Information
Ixxat®is a registered trademark of HMS Industrial Networks AB. All other trademarks mentioned
in this document are the property of their respective holders.
Description
simplyCAN User Manual
4.01.0001.22001 1.0 en-US
User Guide 4 (22)
1.4 Conventions
Instructions and results are structured as follows:
► instruction 1
► instruction 2
→ result 1
→ result 2
Lists are structured as follows:
• item 1
• item 2
Bold typeface indicates interactive parts such as connectors and switches on the hardware, or
menus and buttons in a graphical user interface.
This font is used to indicate program code and other
kinds of data input/output such as configuration scripts.
This is a cross-reference within this document: Conventions, p. 4
This is an external link (URL): www.hms-networks.com
Safety advice is structured as follows:
Cause of the hazard!
Consequences of not taking remediate action.
How to avoid the hazard.
Safety signs and signalwords are used dependent on the level of the hazard.
This is additional information which may facilitate installation and/or operation.
This instruction must be followed to avoid a risk of reduced functionality and/or damage
to the equipment, or to avoid a network security risk.
Caution
This instruction must be followed to avoid a risk of personal injury.
WARNING
This instruction must be followed to avoid a risk of death or serious injury.
simplyCAN User Manual
4.01.0001.22001 1.0 en-US
Safety Instructions 5 (22)
2 Safety Instructions
2.1 Information on EMC
Risk of interference to radio and television if used in office or home environment! The
product is a class B device.
Use exclusively included accessories or HMS accessories that are intended for use with
the device. Use exclusively shielded cables.
Make sure that the shield of the interface is connected with the device plug and the plug
on the other side.
2.2 General Safety Instructions
► Protect product from moisture and humidity.
► Protect product from too high or too low temperature (see Technical Data, p. 11).
► Protect product from fire.
► Do not paint the product.
► Do not modify or disassemble the product. Service must be carried out by HMS Industrial
Networks.
► Store products in dry and dust-free place.
2.3 Intended Use
The device is used to connect computer systems to CAN networks to exchange data for example
to configure a device via CAN or to read device diagnosis data. The simplyCAN is intended for the
connection to a computer via the USB interface.
3 Scope of Delivery
Included in the scope of delivery:
• simplyCAN device
The following is available via download from www.simplycan.info:
• simplyCAN bus monitor
• installation file setup.bat (necessary for Windows 7)
• programming API
• programming examples
• user manual
A CAN bus termination can be ordered separately.
simplyCAN User Manual
4.01.0001.22001 1.0 en-US
Product Description 6 (22)
4 Product Description
The simplyCAN is an active USB adapter which enables the user to connect a computer with a
CAN network to monitor the network traffic and to interact with other network devices. The
simplyCAN is a plug and play device due to the easy installation and the easy-to-use CAN
programming interface.
Features
• USB 1.1 Full-Speed (12 MBit/s)
• 1 x CAN high-speed channel according to ISO 11898-2
• D-Sub 9 fieldbus connection, pin allocation according to CiA 303-1
• USB cable with plug type A
Windows: the simplyCAN is tested on Windows 7 (32 bit and 64 bit)and Windows 10 (64 bit).
Linux: the simplyCAN is tested using Ubuntu 14.04 on Linux kernel version 4.4 as well as Ubuntu 18.04 on
Linux kernel version 4.15.
To access the USB interface administrator rights might be necessary.
simplyCAN User Manual
4.01.0001.22001 1.0 en-US
Loading...