USER MANUAL UMAX070501SCO Version 3.1 Valid for CAN Assistant Scope V3.1.x USER MANUAL CAN Assistant Scope P/N: AX070501SCO In Europe: Axiomatic Technologies Oy Höytämöntie 6 33880 Lempäälä - Finland Tel. +358 3 3595 600 Fax. +358 3 3595 660 www.axiomatic.fi In North America: Axiomatic Technologies Corporation 5915 Wallace Street Mississauga, ON Canada L4Z 1Z8 Tel. 1 905 602 9270 Fax. 1 905 602 9279 www.axiomatic.com
ACRONYMS CAN Controller Area Network CAN Assistant Scope CAN monitoring software tool. Axiomatic P/N AX070501SCO CAN Assistant Visual J1939 CAN monitoring and analysis software tool. Axiomatic P/N AX070501VIS CANopen CAN-based higher layer protocol supported by CAN in Automation (CiA) CD Compact Disk EA Electronic Assistant. Software tool for configuring Axiomatic J1939 CAN units Ethernet Local area network technology defined in IEEE 802.3 collection of standards. ID CAN Message Identifier IP Internet Protocol PC Personal Computer P/N Part Number SAE J1939 CAN-based higher level protocol designed and supported by Society of automobile Engineers (SAE) TCP/IP Transmission Control Protocol/Internet Protocol is the basic communication protocol of the Internet UM User Manual USB Universal Serial Bus User Manual: AX070501SCO. Version: 3.1 ii
TABLE OF CONTENTS 1 INTRODUCTION... 4 2 HARDWARE INSTALLATION... 5 3 CAN ASSISTANT SCOPE CONFIGURATION... 6 3.1 Configuring Converter Parameters... 6 3.1.1 Axiomatic USB-CAN Converter... 6 3.1.2 ESD CAN-USB Converter... 7 3.1.3 Axiomatic Ethernet-CAN Converter... 7 3.1.4 Converter Parameters in Status Bar... 7 3.2 Configuring CAN Filters... 8 3.2.1 ID Range Filters... 9 3.2.2 ID Mask Filters... 9 4 MONITORING CAN TRAFFIC... 10 4.1 Clipboard Operation... 10 5 SENDING CAN MESSAGES... 11 5.1 Clipboard Operations... 11 6 LOGGING CAN TRAFFIC... 12 7 ERROR MESSAGES... 13 8 NOTIFICATION MESSAGES... 14 9 USER INTERFACE BRIEF REFERENCE... 15 10 VERSION HISTORY... 17 User Manual: AX070501SCO. Version: 3.1 iii
1 INTRODUCTION CAN Assistant Scope is a Windows program designed to monitor network traffic on a CAN bus. It displays standard and extended data frames together with remote frame requests and can work together with any high-level CAN protocols: SAE J1939, CANopen, etc. Besides showing network traffic, the CAN Assistant Scope can send single messages to the CAN bus, providing an ability to the user to perform simple debugging tasks. It also has an ability to filter incoming CAN messages and to log CAN traffic in a file for a later investigation. By default, the program uses Axiomatic USB-CAN Converter, part number AX070501, to connect to the CAN bus. CAN Assistant Scope can also work with the following hardware converters: Manufacturer Part Number Description Remark Axiomatic AX070501 Axiomatic USB-CAN Needs a driver. Default Converter in EA Converter Axiomatic AX140900 Axiomatic Ethernet-CAN Does not need a driver Converter ESD C.2064.02 USB-CAN-Mini Needs a driver. Set as: ESD CAN-USB Converter in EA It can also support Axiomatic OEM branded USB and Ethernet CAN converters: Converter Type Part Number Remark Ethernet-CAN Converter AX140901 Compatible with: AX140900, Axiomatic Ethernet- CAN Converter Up to date, all USB to CAN converters require the installation of their own drivers, while Ethernet to CAN converters do not need a driver, they use a standard TCP/IP stack. User Manual: AX070501SCO. Version: 3.1 Page: 4-17
2 HARDWARE INSTALLATION When CAN Assistant Scope uses a default Axiomatic USB-CAN Converter, a converter driver should be installed in the system. The major steps for connecting the Axiomatic USB-CAN Converter to the CAN bus are provided below. Connect the converter to one of the USB PC ports using a standard USB cable. Type of the USB port is not important, since the converter will use a full-speed 12Mbit/s mode supported by all modern USB ports. Install Axiomatic USB-CAN Converter device driver from the Electronic Assistant CD, AX070502IN, or download it from the Axiomatic website: www.axiomatic.com, Log-In section, password: trillium. The driver installation procedure is described in details in the user manual of Axiomatic USB-CAN Converter, AX070501. Connect the CAN side of the converter to the CAN bus. Axiomatic USB-CAN Converter uses a standard DB9 male connector with the following pinout. Pin Number Signal Name 7 CAN High 2 CAN Low 3 CAN Ground 5 Shield 1,4,6,8,9 Not connected Please, ensure that 120Ohm terminal resistors are installed on the bus either inside or outside the CAN modules (carefully check the appropriate documentation for each module). The absence of the resistors or more than two resistors can make the CAN bus not functional. For other hardware converters, see appropriate documentation for connection instructions. After installing the hardware converter, the user can run CAN Assistant Scope software and set up the converter parameters. User Manual: AX070501SCO. Version: 3.1 Page: 5-17
3 CAN ASSISTANT SCOPE CONFIGURATION 3.1 Configuring Converter Parameters To set up the CAN converter parameters, the user should go to the menu: Options CAN Interface Setup. The following dialog will be displayed: 3.1.1 Axiomatic USB-CAN Converter For the Axiomatic USB-CAN Converter, the user can choose a baud rate from a list of commonly used predefined baud rates: 1000, 800, 500, 250, 125, 100, 50, 20, 10 kbit/s. If the user requires a different baud rate, or for some reason needs a full control over the CAN bus timing, the Custom Timing Settings option is available. When this option is selected, the user can directly change the CAN controller timing settings, see the table below: Name Description Range tsec1 Time segment before the sample point minus Synchronization segment. [2 16] Synchronization segment is always equal to 1 for this CAN controller tsec2 Time segment after sample point [1 8] sjw Synchronization jump width [1 4] brp Baud rate prescaler. The value by which the oscillator frequency, equal to 24MHz, is divided for generating the bit time quanta [1 1024] User Manual: AX070501SCO. Version: 3.1 Page: 6-17
For the SAE J1939 standard baud rate, equal to 250 kbit/s, these values are defined the following way: {tsec1=9, tsec2=2, sjw=1, brp=8}. Please, refer to the CAN section of STR71x Microcontroller Reference Manual from ST Microelectronics www.st.com and to the Bosch CAN Specification Version 2.0 for more information on the CAN timing configuration. 3.1.2 ESD CAN-USB Converter When the ESD CAN-USB Converter is selected, the user should set the Logical Network Number assigned to the converter by its driver and chose the baud rate from the drop-down list. A custom timing setting is not provided for this converter. 3.1.3 Axiomatic Ethernet-CAN Converter The Axiomatic Ethernet-CAN Converter allows users to remotely connect to the CAN bus using a TCP/IP network. The user should specify the IP address and port of the remote Axiomatic Ethernet-CAN Converter and the converter port type: UDP or TCP. Please note, that the connection should be open on the converter side by the appropriate firewall settings in order to establish the connection between the CAN Assistant Scope and the converter. The baud rate is not selectable for the Axiomatic Ethernet-CAN Converter. The user can see and change the baud rate and other configuration parameters from the converter configuration website. The Loopback Messages converter configuration parameter, available from the converter configuration website, should be set to Yes to monitor all the CAN bus traffic. Otherwise, messages sent by the converter itself, will not be available for monitoring. This parameter should be set with caution, since enabling the loopback messages can create a condition when the same messages are bounced between two or more converters. 3.1.4 Converter Parameters in Status Bar After converter parameters are set, the type of the CAN converter and the selected baud rate are displayed in the following status bar fields: The Baud Rate field is displayed as Custom for custom timing settings, and as Undefined when the baud rate information is not available for the Axiomatic Ethernet-CAN Converter. The user can retrieve additional information about the CAN converter, including a firmware version number and installed windows drivers, when applicable, from the menu: Options Show Converter Information. Some information may not be available for certain converters. User Manual: AX070501SCO. Version: 3.1 Page: 7-17
3.2 Configuring CAN Filters In some cases, it may be necessary to activate a CAN message filtering to watch only selected CAN traffic. The CAN filters can be configured and activated through the dialog, menu: Options CAN Filter Setup. This dialog provides the user with two sets of CAN message filters: ID Range and ID Mask Filters. Both filters can be used simultaneously and in any combination. If the CAN message identifier satisfies the requirements of one of the active (set ON) filters, the message goes through the filters and appears on the screen and in the CAN file log, if the CAN file logging is activated. The user can check whether the filtering is applied to the incoming CAN traffic by looking at the following status bar field: Messages, sent by the CAN Assistant Scope do not go through the CAN filters and are sent to the CAN bus independently of the filter settings. User Manual: AX070501SCO. Version: 3.1 Page: 8-17
3.2.1 ID Range Filters The ID Range Filters pass through only CAN messages with message IDs from a predefined range: If MessageID [IDMin; IDMax], the message is accepted. These filters are useful in CANopen systems. 3.2.2 ID Mask Filters The ID Mask Filters, to determine if the message can be accepted, first apply the Mask to the message ID and then compare the result with the filter ID. If (MessageID Mask) == ID, the message is accepted. The ID Mask Filters are used in SAE J1939 systems. User Manual: AX070501SCO. Version: 3.1 Page: 9-17
4 MONITORING CAN TRAFFIC To start monitoring CAN traffic, the user should first open CAN port through the menu: File Open CAN Port or by clicking on the Open CAN Port icon in the toolbar. If no error messages appear, the user issues the start CAN monitoring command through the menu: Command Start CAN Monitoring or using the toolbar icon. CAN messages should start appearing in the main program window. To stop CAN monitoring, the user issues the stop monitoring command through the menu: Command Stop CAN Monitoring or using the toolbar icon. Closing CAN port through the menu: File Close CAN Port or by clicking on the toolbar icon monitoring., also stops CAN To clear the current contents of the screen buffer, the user can use the menu command: Command Clear Screen Buffer or the toolbar icon. In the View section of the menu, the user is able to select between the hexadecimal or decimal format of the CAN messages. The selection will be displayed in the status bar field: In the same section, the user can also choose between absolute or relative presentation of the message time, allow or suppress output of the converter errors and notification messages. To help distinguish between different types of CAN messages and also between error and notification messages, each message type uses its own icon when presenting information on the screen. If Axiomatic Ethernet-CAN Converter is used, the Loopback Messages converter configuration parameter, available from the converter configuration website, should be set to Yes. Otherwise, messages sent by the converter will not be available. 4.1 Clipboard Operation The main program window supports a clipboard copy operation. The user can select one or more messages from the screen, copy them to the clipboard, and then paste the messages into any text editor. The header of the window with the names of CAN message fields can be copied to the clipboard as well. User Manual: AX070501SCO. Version: 3.1 Page: 10-17
5 SENDING CAN MESSAGES Messages can be sent to the CAN bus using an auxiliary sending window, which appears under the main program window. The auxiliary window has all necessary forms to enter and edit a CAN message and a button to send it to the CAN bus. If Axiomatic Ethernet-CAN Converter is used, the Loopback Messages converter configuration parameter, available from the converter configuration website, should be set to Yes to monitor the sending messages. The user can use a splitter from the menu: View Split to adjust a size of the window, if necessary. Double-clicking inside the auxiliary window will adjust its layout, trimming off all unused space. 5.1 Clipboard Operations To facilitate entering of CAN messages, the user can use clipboard cut-and-paste operations between the main and auxiliary windows. A message can also be cut and pasted from a text file containing a CAN message log created by the CAN Assistant Scope program. User Manual: AX070501SCO. Version: 3.1 Page: 11-17
6 LOGGING CAN TRAFFIC CAN Assistant Scope has an ability to log CAN traffic in a text format. The CAN file logging operation can be activated from the menu: File Start File Logging or by using the toolbar icon. It can be stopped the same way from the menu: File Stop File Logging or by using the toolbar icon. In case the user wants to store only the most recent messages, the save screen buffer command can be activated from the menu: File Save Screen Buffer or by using the toolbar icon. The file saving dialog for both: File Logging and Saving Screen Buffer commands includes an option to append the new data to the existing file log. User Manual: AX070501SCO. Version: 3.1 Page: 12-17
7 ERROR MESSAGES There are two categories of errors messages supported by the CAN Assistant Scope. The first is fatal errors caused by system or hardware faults. They are displayed to the user in a separate pop-up error window and lead to closing the CAN network connection. To recover from such an error, the user has to reopen the CAN port. The second category of errors includes error messages generated by the CAN converter itself and related to the state of the CAN bus, for example, CAN Bus-Off error. These errors are displayed in the main window together with CAN messages. To this category also belong screen and driver buffer overload errors. User Manual: AX070501SCO. Version: 3.1 Page: 13-17
8 NOTIFICATION MESSAGES Some CAN converters can send Notification Messages to the CAN Assistant Scope. These messages usually report a new state of the converter or an external event, for example, a connection of the converter to an external power supply. The Notification Messages are displayed in the main window together with CAN messages. User Manual: AX070501SCO. Version: 3.1 Page: 14-17
9 USER INTERFACE BRIEF REFERENCE The main elements of the user interface, together with toolbar buttons, are described in the following picture. User Manual: AX070501SCO. Version: 3.1 Page: 15-17
The following table presents all CAN Assistant Scope menu commands. Toolbar Icon Command Menu Group Shortcut About CAN Assistant Scope Help Ctrl-A CAN Filter Setup Options Ctrl-F CAN Interface Setup Options Ctrl-I Clear Screen Buffer Command Ctrl-E Close CAN Port File Ctrl-C Exit File Ctrl-X Open CAN Port File Ctrl-C Save Screen Buffer File Ctrl-B Show Absolute Time View Alt-T Show Converter Errors View Alt-E Show Converter Information Options Ctrl-H Show Converter Notifications View Alt-N Show Decimal Format View Alt-D Split View Ctrl-P Start CAN Monitoring Command Ctrl-S Start File Logging File Ctrl-L Status Bar View Ctrl-R Stop CAN Monitoring Command Ctrl-S Stop File Logging File Ctrl-L Toolbar View Ctrl-O Help Help F1 User Manual: AX070501SCO. Version: 3.1 Page: 16-17
10 VERSION HISTORY Software Version User Manual Version 3.1.x 3.1 August 2, 2016 3.0.x 3.0 June 20, 2016 2.0.x 2.00 August 28, 2007 1.1.x 1.01a July 23, 2007 1.1.x 1.01 April 30, 2007 Date Author Modifications Olek Bogush Olek Bogush Amanda Wilkins Olek Bogush Olek Bogush Changed kbit/s to kbit/s. Added small corrections throughout the document. Added support for Axiomatic Ethernet-CAN Converter. Added section: 8 NOTIFICATION MESSAGES. Updated and clarified other parts of the user manual. Moved VERSION HISTORY to the end of the document. Reviewed the user manual. Changed the software name and the part number. Changed the European office address. Small updates in different parts of the user manual. Initial release. Each major release of the software has its own user manual. Two most significant digits of the software version number define the major release and determine its valid user manual version number. For example, the current user manual is valid with any software version 3.0.x. The last digit in the software version number is used for minor releases including small updates, bug fixes, etc., which do not affect the manual contents. Changes to the user manual for the same software major release are implemented, if necessary, by adding letters to the user manual version number, for example, 3.0A (or 3.0a), 3.0B, etc. The letters are not case sensitive, but capital letters are preferred. User Manual: AX070501SCO. Version: 3.1 Page: 17-17