CANscript. Python-Scripting Tool for Processing CAN-Messages. Software Manual. CANscript Software Manual Rev. 1.1 Page 1 of 15

Transcription

1 CANscript Python-Scripting Tool for Processing CAN-Messages Software Manual CANscript Software Manual Rev. 1.1 Page 1 of 15 esd electronic system design gmbh Vahrenwalder Str Hannover Germany Fax: 0511/ Phone: 0511/ International:

2 N O T E The information in this document has been carefully checked and is believed to be entirely reliable. esd makes no warranty of any kind with regard to the material in this document, and assumes no responsibility for any errors that may appear in this document. esd reserves the right to make changes without notice to this, or any of its products, to improve reliability, performance or design. esd assumes no responsibility for the use of any circuitry other than circuitry which is part of a product of esd gmbh. esd does not convey to the purchaser of the product described herein any license under the patent rights of esd gmbh nor the rights of others. esd electronic system design gmbh Vahrenwalder Str Hannover Germany Phone: Fax: info@esd-electronics.com Internet: USA / Canada: esd electronics Inc. 525 Bernardston Road Suite 1 Greenfield, MA USA Phone: Fax: us-sales@esd-electronics.com Internet: Page 2 of 15 Software Manual Rev. 1.1 CANscript

3 Document file: I:\texte\Doku\MANUALS\PROGRAM\CAN\CAN-Tools\CANscript\Englisch\CANscript_11.en9 Date of print: Changes in the chapters The changes in the document listed below affect changes in the software as well as changes in the description of facts, only. Chapter 1.1 Changes versus previous version Chapter Installation subdivided in chapter Installation of CANscript via CAN SDK and Python Installation and Setup 3. Description of program start completed Technical details are subject to change without prior notice. CANscript Software Manual Rev. 1.1 Page 3 of 15

4 This page has intentionally been left blank. Page 4 of 15 Software Manual Rev. 1.1 CANscript

5 Contents 1. Introduction Installation and Program Call CANscript Installation with CAN SDK Python Installation and Setup Functions of the User-Interface Elements Display of the CANscript Program Window Menu Bar Opening a Python Script Closing a Python Script Selecting the Editor and the Paths of the Pythons Scripts Closing the Program CANscript Display Window Editing a Python Script Clearing the Display Window Closing the Python Script Starting / Stopping a Python Script Quick Start CANscript Software Manual Rev. 1.1 Page 5 of 15

6 CANscript Introduction 1. Introduction This document describes the program CANscript. CANscript is a Python-Scripting tool to handle CAN-messages. Via CANscript Python scripts can be executed under a standard user interface. The program offers: - execution and management of Python scripts - allows quick and easy creation of user-defined powerful CAN-applications - supporting the esd-api in combination with esd CAN-hardware interfaces - helpful run-time status message - supporting the output of user-defined text messages and data in the status window. 1.1 Installation and Program Call CANscript Installation with CAN SDK The tool CANscript is contained in the CAN SDK, which is distributed with the esd-can-cd or can be downloaded from the esd-homepage ( At the installation of the SDK (Software Development Kit) the program CANscript is automatically installed. Start the SDK-installation file Can_sdk\setup.exe on the esd-can-cd and carry out the installation. If not defined at the installation differently, after successful installation the program CANscript can be started under Windows by selecting the menu items Start / Program files / CAN / CANscript Python Installation and Setup In order to execute the scripts Python (version 2.3 or higher) has to be installed. A Python version can be found on the esd-can-cd. Current versions of the free script language "Python" can be downloaded from the website Install Python and then restart your computer! In the following PYTHONPATH represents the installation subdirectory of the Python version and CAN_SDK_PATH the installation path of the CAN SDK. The following files have to be copied manually from the subdirectory CAN_SDK_PATH\lib\python to the directory PYTHONPATH\Lib\site-packages: - _ntcan.dll (from Python 2.5: ntcan.pyd) - ntcan.py The file _ntcan.dll (_ntcan.pyd) depends on the Python version and must be selected correspondingly. In order to be able to access the functions and objects from module ntcan.py, in the Python scripts Page 6 of 15 Software Manual Rev. 1.1 CANscript

7 CANscript Introduction import_ntcan must have been entered. Some example scripts can be found under: CAN_SDK_PATH\bin32\CANscript\scripts canopen.py util.py main.py - contains CANopen functions - contains miscellaneous auxiliary functions - contains examples for the use of the canopen.py-library To edit the scripts we recommend a free Scintilla-based editor, such as: - Anyedit - Notepad++ notepad-plus.sourceforge.net - Programmers Notepad 2 -SciTE These editors can be downloaded from the homepages under the addresses mentioned above and installed on your computer. CANscript Software Manual Rev. 1.1 Page 7 of 15

8 CANscript Program Window 2. Functions of the User-Interface Elements 2.1 Display of the CANscript Program Window Page 8 of 15 Software Manual Rev. 1.1 CANscript

9 CANscript Program Window The program window is divided into the following fields: - Menu bar Contains the main menu. It includes commands for opening and closing Python-scripts and options for managing and monitoring them. - Display window The display window is divided into registers. Each register shows the respective output of a Python script. - Buttons Via the buttons individual functions for the display and about the operation of the script can be called. - Name of the Python script Name of the current Python script, displayed in the upper register. - Number of opened Python scripts Number of Python scripts opened and represented as register. CANscript Software Manual Rev. 1.1 Page 9 of 15

10 CANscript Menu Bar 2.2 Menu Bar The menu bar includes the menu items File and Help. The menu items are opened by a single mouse click Opening a Python Script By selecting the menu item File / Open... a Python script can be opened. Open... Opens a Python script For this the following dialogue box Select one or more files to open is opened. An existing Python script can also be opened via the key combination Crtl+O. Here you can select an existing Python script. The scripts have got the extension *.py. With Open you select the script. Opened scripts are shown in a register in the display window (see page 12). Opening several Python scripts will open correspondingly many registers in the display window. Via Cancel you can leave the selection window without opening a script Closing a Python Script By selecting the menu items File /Close and Close all Python scripts can be closed. Close Closes the script currently represented in the display window. If the selected script is still operating, you will be asked for confirmation before it is closed. Close All Closes all opened Python scripts. Page 10 of 15 Software Manual Rev. 1.1 CANscript

11 CANscript Menu Bar Selecting the Editor and the Paths of the Pythons Scripts By selecting the menu item File / Options an editor and the path of the Python scripts can be set. Options In this selection box the paths of the editor and the directory in which the Python scripts are stored can be set. Editor In order to set the editor with which the scripts can be displayed enter the file with which the editor is launched with the respective path. You can also choose the file directly via the browser. Python Scripts (Default) Here the path of the directory can be entered under which the Python scripts are stored as a default. The path can either be entered directly or selected via the browser. Confirm the entries with OK, or choose Cancel to close the selection window without accepting the changes Closing the Program CANscript By selecting the menu item File / Exit you can close the program CANscript. Exit Via Exit you close the program CANscript. CANscript Software Manual Rev. 1.1 Page 11 of 15

12 CANscript Display Window 2.3 Display Window The display window is divided into registers. Each register contains the outputs of a Python scripts. After opening a script via the menu items File / Open the register of the script appears in the display window. In addition to the file name of the script the tab contains a status box. This represents the status of the Python script. Newly opened Python scripts which have not yet been started are represented by a white status box and the window does not contain further entries, yet. Colour white green red yellow green/red yellow/red Meaning of the colour of the status box of the tab script opened (not yet executed) script operating script was stopped according to errors script was stopped manually or has run through to the end script is running, but warnings or errors occurred during execution script was stopped manually or has run through to the end and warnings or errors occurred If several Python scripts are open, the registers are superimposed. You can select a register and therefore the according Python script by means of the tabs. In the lower left corner of the display window the complete path and file name of the Python script is shown. The buttons for starting/stopping and editing the current script are in the right corner. Page 12 of 15 Software Manual Rev. 1.1 CANscript

13 CANscript Display Window Editing a Python Script Edit By clicking the Edit button the current Python script is shown by the editor which was set under Options. The Python script can be edited with the editor. The design of the editor window depends on the editor that is used. The following figure represents the Python script main.py with the editor Programmers Notepad2 as an example Clearing the Display Window Clear By clicking the Clear button the current output of Python scripts is deleted. The output window is then clear again Closing the Python Script Close Clicking the Close button closes the displayed Python script. CANscript Software Manual Rev. 1.1 Page 13 of 15

14 CANscript Display Window Starting / Stopping a Python Script Start/Stop Via the Start button the Python script displayed in the current register lying in front is started. After the program has been started it can be stopped via the same button with Stop. The window represents the start time and the outputs of the Python script. If the Python script has stopped running, the time will be displayed at which the program was stopped. Times are given in green. If an error occurs during the operation of the Python script, an error message will be shown in the flow trace. The error message will be shown in red. Page 14 of 15 Software Manual Rev. 1.1 CANscript

15 CANscript Quick Start 3. Quick Start Please follow the steps below for an easy program application: 1. Install the CAN SDK on your computer. CANscript is installed with the CAN SDK as one of the CAN Tools. In order to be able to execute the scripts Python (version 2.3 or higher) has to be installed, too. A Python version can be found on the esd-can-cd. Please also copy the files _ntcan.dll and - ntcan.py, as described on page If not defined at the installation differently, after successful installation the program CANscript can be started under Windows by selecting the menu items Start / Program files / CAN / CANscript. 3. To open a Python script select the script in the main menu under File via the menu item Open. The selected window then appears in the current tab of the display window. 4. Start playing back the Python script via the Start button. 5. The outputs of the Python script will then be represented in the display window. 6. Stop the playback of data via the Stop button. CANscript Software Manual Rev. 1.1 Page 15 of 15

16