Hercules Quick Start on: Program Blocks Editor/Compiler (PBEC) 1. Hercules Program Blocks and the Editor/Complier Application

Size: px

Start display at page:

Download "Hercules Quick Start on: Program Blocks Editor/Compiler (PBEC) 1. Hercules Program Blocks and the Editor/Complier Application"

Caroline Warner
6 years ago
Views:

1. Hercules Program Blocks and the Editor/Complier Application Program Blocks are compiled ANSI C code complied to run from within the Gryphon Hardware.

frames and provide additional user defined detail (written to the Information View window).

1 1. Hercules Program Blocks and the Editor/Complier Application Program Blocks are compiled ANSI C code complied to run from within the Gryphon Hardware. Within Hercules an Editor/Complier is provided to create Program Blocks and a Download function within Hercules enables the hardware to provide the user with more flexibility to transmit message frames and provide additional user defined detail (written to the Information View window). A program block is composed of ANSI C code and is executed in response to eight specific events: OnError( ) OnFrame( ) OnKey( ) OnStart( ) OnStop( ) OnTimer( ) OnTrigger( ) OnSerial( ) The following two items are required: Hardware: Dearborn Group s Gryphon family products (S-CAT, S-CAT2, S3, G1, G2). Software: Dearborn Group s Hercules Protocol Analyzer software. 2. Using Hercules Program Blocks To access Program Blocks: Select Configuration. Select Program Blocks The Program Blocks window will appear. Program Blocks provides functionality for the following: Open Editor Select Download Enable Program Block Opens the Program Block Editor and Compiler. Allows creation or opening of (*.psf) files and the compiling of (*.psf) file into (*.out) file. Selects a (*.out) file for download. Downloads a (*.out) file to the Gryphon family hardware. Enables the downloaded Program Block for execution on the Gryphon family hardware. 1

Select / Download Program Block Features: From the Program

This causes the Open window to appear allowing the User to

Highlight the file and click the Open button.

2 Select / Download Program Block Features: From the Program Blocks main selection box, click on the Select button. This causes the Open window to appear allowing the User to search through the file system to find the desired file. Highlight the file and click the Open button. This closes the window. Select the Download button: A successful download will generate the screen shown below. 2

3 Clicking the OK button will close the message box and allow the box for Enable Program Block to be selected with a click. A check will appear in the box to indicate it will be enabled after the OK button is selected. Clicking the Hercules Start button will begin the On-line session with the Program Block executing. Selecting Display Information View will display the Information View window. Initially, a message will appear indicating Program block execution successful! after clicking Start button. The Program Block will continue to execute while the On-line session continues. After clicking the Stop button, a message will appear indicating Program block stopped successfully! 3

The File menu bar selection: Provides the following options: New Program Source File Open Program Source File

4 3. Using the Editor/Compiler Click on Open Editor to open the Program Block Editor and Compiler. The Code Viewer shows References, Functions, and eight Events. The File menu bar selection: Provides the following options: New Program Source File Open Program Source File will open an existing file to view or edit. Save Program Source File with an extension of (*.psf). Save Program Source File As with a different file name and an extension of (*.psf). 4

5 The Compile menu bar selection reveals Build Exe, which will begin the compile process if the files have been saved. You will be prompted to save to a file before compiling if it has not already been saved. Clicking the Yes selection will save the file and begin the compiling process. The compile process will show the window below. A successful compilation will be indicated by the text finished compiling. The executable file (*.out) will be saved to the same location as the source code file (*.psf). Press any key to continue and the window will close. A compiled file has an extension of *.out. 5

4. In-tool HELP Selecting the Program Block Editor and Compiler Help menu: This selection provides the user with in-tool Help files and the Hot Key descriptions.

Library Functions WriteInfo TransmitDataFrame TransmitError StartTimer StopTimer FreeDataFrame SendSerial SendTrigger DecodeData EncodeData CreateDataFrame In-tool Help example: The in-tool Help

6 4. In-tool HELP Selecting the Program Block Editor and Compiler Help menu: This selection provides the user with in-tool Help files and the Hot Key descriptions. The in-tool Help provides descriptions on how to create a Function, how to use the library routines that can be used anywhere in the source file and how to utilize the predefined DataFrame Structure. Library Functions WriteInfo TransmitDataFrame TransmitError StartTimer StopTimer FreeDataFrame SendSerial SendTrigger DecodeData EncodeData CreateDataFrame In-tool Help example: The in-tool Help files contain the detail needed to write code with the correct syntax for this compiler. Sample source files are included with the installation file in folder c://program files/hercules/pbec. Selecting one of the sample files in your Program Block Editor will provide quick examples of the code that is needed. 6

7 Sample Code: References Section in the Code Viewer Declarations set and Comments. 7

8 Functions Section in the Code Viewer WriteInfo will display text to the Information View window when this function is called. 8

9 Functions Section in the Code Viewer Continued Struct is created and WriteInfo displays text to the Information View window. 9

10 Events Section in the Code Viewer Displaying the OnFrame event If a frame is received or transmitted, WriteInfo will display text to the Information View window. Different messages will be transmitted based on the MODE_TX or MODE_RX values and the channel values. 10

11 Events Section in the Code Viewer Displaying the OnKey event WriteInfo will display text to the Information View window when the Event occurs. DataFrames of STD CAN and EXT CAN are created. 11

12 OnKey event continued WriteInfo will display text to the Information View window. A Frame is transmitted when key A or key B is pressed. The function definestsructanddisplay is called when key J is pressed. A Timer is started when key P is pressed. The timer is stopped when key P is pressed. The OnStart timer is stopped when key S is pressed. 12

13 OnKey continued WriteInfo will display text to the Information View window. Function2 is called if key M is pressed. The printfunction is called, an EXT CAN frame is created, and frames are transmitted when key T is pressed. 13

14 Events Section in the Code Viewer Displaying the OnStart event WriteInfo will display text to the Information View window at the start of the Online session. A Timer is started. 14

15 Events Section in the Code Viewer Displaying the OnStop event WriteInfo will display text to the Information View window when the Event occurs and FreeDataFrame is called to clear out free memory. 15

16 Events Section in the Code Viewer Displaying the OnTimer event When the OnTimer event occurs, WriteInfo will display text in the Information View window. 16

17 Events Section in the Code Viewer Displaying the OnTrigger event WriteInfo will display text to the Information View window when the Event occurs. 17

18 Events Section in the Code Viewer Displaying the OnSerial event WriteInfo will display text to the Information View window when the Event occurs. 18

19 5. Example: OnKey PARAM_INFO EncodeData DecodeData void OnKey(char character) { /*Ctrl I encodes the data, Value is set to 1. Decodes the data and is displayed in the Information View window.*/ if(character=='i') { unsigned char data[50]; char encodestring[100]; PARAM_INFO testhermann; double value; int loop = 0; int sbyte; int sbit; int slen; double sendval = 1.0; memset (data,0,50); sbyte = 0; sbit = 0; slen = 16; value = 0; testhermann.m_startbyte = sbyte; testhermann.m_startbit = sbit; testhermann.m_paramlength = slen; testhermann.m_resolution = 1; testhermann.m_offset = 0; testhermann.m_signedunsignedflag = 0; testhermann.m_applyscaling = 1; if(encodedata (data, 10,testHermann, sendval ) == 0) { sprintf (encodestring,"value was %f", sendval); WriteInfo (encodestring); sprintf (encodestring,"data = %02X %02X %02X %02X %02X %02X %02X %02X",data[0],data[1],data[2],data[3],data[4],data[5],data[6],data[7] ); WriteInfo (encodestring); WriteInfo ("Now let's decode it!"); if (DecodeData (data, 10, testhermann, &value) == 0) { sprintf (encodestring, "Decode Val = %f", value); WriteInfo (encodestring); 19

20 } } } /*Press Ctrl K at same time the PARAM_INFO will be defined and then the data will be displayed in the Information View window. Encode Data and Decode Data is used. Loops 5 times and increments the 4th data byte by 5 */ else if (character == 'K') { unsigned char data[50]; char encodestring[100]; PARAM_INFO testhermann; double value; int loop = 0; int sbyte; int sbit; int slen; double sendval = 50.0; memset (data,0,50); sbyte = 2; sbit = 1; slen = 16; value = 0; testhermann.m_startbyte = sbyte; testhermann.m_startbit = sbit; testhermann.m_paramlength = slen; testhermann.m_resolution = 5; testhermann.m_offset = 0; testhermann.m_signedunsignedflag = 0; testhermann.m_applyscaling = 1; if (EncodeData (data, 10, testhermann, sendval) == 0) { sprintf (encodestring, "Value was %f", sendval); WriteInfo (encodestring); sprintf (encodestring, "Data = %02X %02X %02X %02X %02X %02X %02X %02X", data[0],data[1],data[2],data[3],data[4],data[5],data[6],data[7] ); WriteInfo (encodestring); WriteInfo ("Now let's decode it!"); if (DecodeData (data, 10, testhermann, &value) == 0) { sprintf (encodestring, "Decode Val = %f", value); 20

21 WriteInfo (encodestring); } } for (loop =1; loop<6; loop++) { memset (data, 0, 10); EncodeData (data, 10, testhermann, sendval+(loop*5) ); sprintf (encodestring,"data = %02X %02X %02X %02X %02X %02X %02X %02X", data[0],data[1],data[2],data[3],data[4],data[5],data[6],data[7] ); WriteInfo (encodestring); } DecodeData (data, 10, testhermann, &value); sprintf (encodestring, "Hermann Increment + 5 = %f", value); WriteInfo (encodestring); } } else WriteInfo ("You have pressed the wrong keys"); 21

Program Block Editor and Compiler (PBEC)

Program Block Editor and Compiler (PBEC) For Hercules User Manual Version 1.7.5 2007 Dearborn Group Inc. 27007 Hills Tech Court Farmington Hills, MI 48331 Phone (248) 488-2080 Fax (248) 488-2082 http://www.dgtech.com