CAN BUS Analyzer User’s Guide 2011 Microchip Technology Inc.
Note the following details of the code protection feature on Microchip devices: • Microchip products meet the specification contained in their particular Microchip Data Sheet. • Microchip believes that its family of products is one of the most secure families of its kind on the market today, when used in the intended manner and under normal conditions. • There are dishonest and possibly illegal methods used to breach the code protection feature.
CAN BUS ANALYZER USER’S GUIDE Table of Contents Preface ........................................................................................................................... 5 Introduction............................................................................................................ 5 Document Layout .................................................................................................. 5 Conventions Used in this Guide ...........................................................
CAN Bus Analyzer User’s Guide NOTES: DS51848B-page 4 2011 Microchip Technology Inc.
CAN BUS ANALYZER USER’S GUIDE Preface NOTICE TO CUSTOMERS All documentation becomes dated, and this manual is no exception. Microchip tools and documentation are constantly evolving to meet customer needs, so some actual dialogs and/or tool descriptions may differ from those in this document. Please refer to our web site (www.microchip.com) to obtain the latest documentation available. Documents are identified with a “DS” number.
CAN Bus Analyzer User’s Guide CONVENTIONS USED IN THIS GUIDE This manual uses the following documentation conventions: DOCUMENTATION CONVENTIONS Description Arial font: Italic characters Initial caps Quotes Underlined, italic text with right angle bracket Bold characters N‘Rnnnn Text in angle brackets < > Courier New font: Plain Courier New Represents Referenced books Emphasized text A window A dialog A menu selection A field name in a window or dialog A menu path MPLAB® IDE User’s Guide ...
Preface WARRANTY REGISTRATION Please complete the enclosed Warranty Registration Card and mail it promptly. Sending in the Warranty Registration Card entitles users to receive new product updates. Interim software releases are available at the Microchip web site. RECOMMENDED READING This user's guide describes how to use the CAN Bus Analyzer on a CAN network. The following Microchip documents are available on www.microchip.
CAN Bus Analyzer User’s Guide THE MICROCHIP WEB SITE Microchip provides online support via our web site at www.microchip.com. This web site is used as a means to make files and information easily available to customers.
Preface CUSTOMER SUPPORT Users of Microchip products can receive assistance through several channels: • • • • Distributor or Representative Local Sales Office Field Application Engineer (FAE) Technical Support Customers should contact their distributor, representative or field application engineer (FAE) for support. Local sales offices are also available to help customers. A listing of sales offices and locations is included in the back of this document.
CAN Bus Analyzer User’s Guide NOTES: DS51848B-page 10 2011 Microchip Technology Inc.
CAN BUS ANALYZER USER’S GUIDE Chapter 1. Introduction 1.1 INTRODUCTION The CAN BUS Analyzer Tool is intended to be a simple-to-use, low-cost CAN Bus monitor which can be used to develop and debug a high-speed CAN network. The tool features a broad range of functions which allow it to be used across various market segments including automotive, marine, industrial and medical. The CAN Analyzer tool supports CAN 2.0b and ISO 11898-2 (high-speed CAN with transmission rates of up to 1 Mbit/s).
CAN Bus Analyzer User’s Guide 1.4 CAN BUS ANALYZER HARDWARE FEATURES The CAN BUS Analyzer hardware is a compact tool that includes the following hardware features. Refer to Section 1.5 “CAN BUS Analyzer Software” for more information about the software features. FIGURE 1-1: CAN BUS ANALYZER • Mini USB Connector This connector provides the CAN BUS Analyzer a communication medium to the PC, but it can also provide a power supply if the external power supply is not plugged into the CAN BUS Analyzer.
VCC Q1 R11 0 470 U4-1 IOVL1 IOVCC1 3-State U5-2 IOVL2 IOVCC2 C8 0.1uF S2 MAX3378E 2 8 3 VCC D4 1K 1N4148WS R19 1 2 3 4 C6 0.
CAN Bus Analyzer User’s Guide 1.5 CAN BUS ANALYZER SOFTWARE The CAN BUS Analyzer comes with two firmware hex files and PC software which provides the user with a graphical interface to configure the tool and analyze a CAN network. It has the following software tool features: 1. Trace: Monitor the CAN bus traffic. 2. Transmit: Transmit single shot, periodic, or periodic messages with a limited repeat onto the CAN bus. 3. Group Transmit: Transmit a list of CAN messages, in order, onto the CAN bus. 4.
CAN BUS ANALYZER USER’S GUIDE Chapter 2. Installation 2.1 INTRODUCTION The following chapter describes the procedures for installing the CAN Analyzer hardware and software. The chapter contains the following information: • Installing CAN BUS Analyzer Software • Installing CAN BUS Analyzer Hardware 2.2 SOFTWARE INSTALLATION 2.2.1 Installing the GUI Install .NET framework version 3.5 before installing the CAN BUS Analyzer. 1. Run “CANAnalyzer_verXYZ.
CAN Bus Analyzer User’s Guide 2.3 HARDWARE INSTALLATION 2.3.1 System Requirements • Windows® XP • .NET framework version 3.5 • USB Serial Port 2.3.2 Power Requirements • A power supply (9 to 24 Volt) is needed when operating without the PC and when updating firmware in the USB PIC MCU • The CAN BUS Analyzer tool can also be powered using the USB port 2.3.
Installation TABLE 2-2: 6-PIN SCREW CONNECTOR PINOUT Pin Number Signal Names Signal Description PIC® 1 Vcc 2 CAN_L Dominant Low 3 CAN_H Dominant High 4 RXD CAN Digital Signal from Transceiver 5 TXD CAN Digital Signal from PIC18F2680 6 GND Ground FIGURE 2-2: 2011 Microchip Technology Inc.
CAN Bus Analyzer User’s Guide NOTES: DS51848B-page 18 2011 Microchip Technology Inc.
CAN BUS ANALYZER USER’S GUIDE Chapter 3. Using the PC GUI Once the hardware is connected and the software is installed, open the PC GUI using the shortcut in the Programs Menu under “Microchip Technology Inc” labeled as Microchip CAN Tool ver XYZ. Figure 3-1 is a screen shot of the default view for the CAN BUS Analyzer. FIGURE 3-1: 3.1 CAN BUS ANALYZER DEFAULT VIEW GETTING STARTED WITH A QUICK SETUP The following are setup steps to quickly start transmitting and receiving on the CAN BUS.
CAN Bus Analyzer User’s Guide 3.2 TRACE FEATURE There are two types of Trace windows: Fixed and Rolling. To activate either Trace window, select the option from the main Tools menu. FIGURE 3-2: FIXED TRACE WINDOW FIGURE 3-3: ROLLING TRACE WINDOW The Trace window displays the CAN BUS traffic in a readable form. This window will list the ID (Extended is signified with an preceding 'x' or Standard), DLC, DATA Bytes, the Time stamp and the time difference from the last CAN BUS message on the BUS.
Using the PC GUI 3.3 TRANSMIT FEATURE To activate the Transmit window, select “TRANSMIT” from the main Tools menu. FIGURE 3-4: TRANSMIT WINDOW The Transmit window allows the user to interact with other nodes on the CAN BUS by transmitting messages. The user is able to enter any ID (Extended or Standard), DLC or DATA Bytes combination for single message transmittal.
CAN Bus Analyzer User’s Guide 3.4 FUTURE FEATURE – GROUP TRANSMIT FEATURE To activate the Group Transmit window, select “GROUP TRANSMIT” from the main Tools menu. FIGURE 3-5: GROUP TRANSMIT WINDOW The Group Transmit window allows the user to interact with other nodes on the CAN BUS by transmitting messages. The user is able to transmit a limited group of messages in sequential order spaced out by user-defined timing in the Period field.
Using the PC GUI 3.5 FUTURE FEATURE –TRACE FILTER SETUP FEATURE To activate the Trace Filter Setup window, select “TRACE FILTER SETUP” from the main Tools menu. FIGURE 3-6: TRACE FILTER SETUP WINDOW The Trace Filter Setup window allows the user to filter the Trace window for only the required IDs the user wants to view. The trace filter can match the log file filter or it can contain a completely different set of IDs. Steps to setup the trace filter to match the log file filter 1.
CAN Bus Analyzer User’s Guide 3.6 LOG FILE SETUP FEATURE To activate the Log File Setup window select “LOG FILE SETUP” from the main Tools menu. FIGURE 3-7: LOG FILE SETUP WINDOW The Log File Setup window allows the user to setup a log file of the CAN BUS traffic. This feature helps gather more information when debugging design issues, by capturing the BUS traffic when an event occurs. Log File Setup also allows the user to setup a filter to either include or exclude user-defined IDs.
Using the PC GUI 3.7 HARDWARE SETUP FEATURE To activate the Hardware Setup window, select “HARDWARE SETUP” from the main Tools menu. FIGURE 3-8: HARDWARE SETUP WINDOW The HARDWARE SETUP window allows the user to setup the CAN BUS Analyzer for communication on the CAN BUS. This feature also gives the user the ability to quickly test the hardware on the CAN BUS Analyzer. To set up the tool to communicate on the CAN BUS: 1. Select the CAN bitrate from the drop-down combo box. 2. Click the “Set” button.
CAN Bus Analyzer User’s Guide 3.8 FUTURE FEATURE – SAVING AND RETRIEVING THE TOOL CONFIGURATIONS 3.8.1 Saving Tool Configurations The CAN BUS Analyzer tool allows the user to save various configuration setups by the user in a particular session. The GUI will save the transmit window settings, log file settings, and screen positions of the various windows of the tool. By choosing “Save Configuration” under the File menu, the file is saved in a default Temp folder under the default name “config.ini”.
CAN BUS ANALYZER USER’S GUIDE Appendix A. Error Messages In this section, the various “pop-up” errors that are found in the GUI will be discussed in detail as to why they may occur, and the possible solutions for correcting the errors. TABLE A-1: ERROR MESSAGES Error Number Error Possible Solution 1.00.x Trouble reading the USB firmware version Unplug/plug the tool into the PC. Also make sure that the PIC18F2550 is programmed with the proper HEX file. 2.00.
CAN Bus Analyzer User’s Guide Error Number Error Possible Solution 4.10.x Enter DLC within the following range (0-8) 4.20.x Enter DATA within the following range Enter valid Data into the text field. The tool is expecting (0-FF) a hexidecimal value in the range of “0-FF”. 4.25.x Enter DATA within the following range Enter valid Data into the text field. The tool is expecting (0-255) a decimal value in the range of “0-255”. 4.30.
Error Messages NOTES: 2011 Microchip Technology Inc.
Worldwide Sales and Service AMERICAS ASIA/PACIFIC ASIA/PACIFIC EUROPE Corporate Office 2355 West Chandler Blvd. Chandler, AZ 85224-6199 Tel: 480-792-7200 Fax: 480-792-7277 Technical Support: http://www.microchip.com/ support Web Address: www.microchip.