CAPL Scripting Quickstart

CAPL (Communication Access Programming Language) For CANalyzer and CANoe

V1.01 | 2015-12-03
 Agenda

u Important information before getting started 3

Visual Sequencer (GUI based programming (Subset of CAPL)) 7
Brief Introduction to CAPL 11
Notes on Panel creation and use 24
Where to find additional information 28
Contact Information 30

2
 Important information before getting started
CANalyzer versus CANoe
CANalyzer is wholly contained within CANoe

CANoe

Simulation Test

Diagnostics CANalyzer
Analysis

Ethernet
MOST
FlexRay
LIN
CAN
CANoe offers significant additional capability beyond CANalyzer to:
> Stimulate the network(s) with Interaction Layer knowledge
> Run automated tests and generate test reports
> Implement automated diagnostic tests
3
 Important information before getting started
CANoe and the added value of the Interaction Layer

u The CANoe Interaction Layer (in short CANoeIL):

> Provides a signal-oriented means of accessing the bus
> Map signals to their appropriate send messages
> Controls the sending of these messages as a function of the (OEM) Send Model
u Transmission of messages and signals is described based on attributes in the database
u CANoeIL models the transmission behavior at run-time using those attributes
4
 Important information before getting started
Overview of CANalyzer variants

CAPL is available in CANalyzer PRO and all versions of CANoe

CANalyzer is available in three different variants:

u PRO: Professional variant: full functionality

u EXP: Expert variant: supports all applications up to

complex analysis of heterogeneous systems; does
not support CAPL programs

u FUN: Fundamental variant: simple applications, does not

support CAPL, diagnostic tester and panels

Detailed information about the variants of CANalyzer is available at our

website: http://www.vector.com/vi_canalyzer_variants_en.html

5
 Agenda

Important information before getting started 3

u Visual Sequencer (GUI based programming (Subset of CAPL)) 7
Brief Introduction to CAPL 11
Notes on Panel creation and use 24
Where to find additional information 28
Contact Information 30

6
 Visual Sequencer (GUI based programming (Subset of CAPL))
General

Available in both CANalyzer PRO and EXP

> Intended to allow some automation within the EXP variant

The Visual Sequencer allows you to create automated command sequences

with the purpose of
> Stimulating the network
> Controlling applications

In order to structure the individual steps, loops and conditional command

blocks can be used, such as
> if, else if, end if

Each sequence is shown in a separate window, and can be edited at any

time, even while a measurement is running.

7
 Visual Sequencer (GUI based programming (Subset of CAPL))
Features

u Send messages (cyclically)

u Set signals/variables
u If, else, else if and
repeat commands
u Wait commands
u Start/stop replay
u Write text or values
to write window or file
u Graphical debug
u Auto complete for names

8
 Visual Sequencer (GUI based programming (Subset of CAPL))
See the CANsystemdemo.cfg included with your installation

9
 Agenda

Important information before getting started 3

Visual Sequencer (GUI based programming (Subset of CAPL)) 7
u Brief Introduction to CAPL 11
Notes on Panel creation and use 24
Where to find additional information 28
Contact Information 30

10
 Brief Introduction to CAPL
General

Functional blocks based on CAPL (Communication Access Programming

Language) can be created to program
u Network node modules
u Special evaluation programs for individual applications

Some CAPL characteristics:

u C-like programming language
u Event based, not interrupt driven
u CAPL programs are created using an integrated development
environment called the CAPL Browser
u Direct access to signals, system variables and diagnostic parameters
u Able to link user created DLLs

11
 Brief Introduction to CAPL
Field of Application CANoe

u Creating and extending simulations

u Implementing functions for analysis in the measurement setup

Simulation Setup Measurement Setup

12
 Brief Introduction to CAPL
Field of Application CANalyzer

u Creating simulations or reactive scripts

u Implementing functions for analysis in the measurement setup

Send Loop of the Measurement Setup Analysis Branches

13
 Brief Introduction to CAPL
CAPL Browser

14
 Brief Introduction to CAPL
Compiling

u In order to generate an executable program file from a CAPL program,

the program must be compiled with the CAPL compiler:

u Error messages are shown in the lower Message Window:

When you double-click the error description, the cursor in the Text
Editor automatically jumps to the point in the source code, where the
error originated.

15
 Brief Introduction to CAPL
Examining a CAPL program

Additional CAPL files that contain generic code

that can be reused in other programs

Variables defined here are accessible

throughout the CAPL program

Multiple pre-defined event handlers exist for

your use within CAPL. The code in this handler
will only be executed when the event occurs.

You can create your own functions (special

handler) that contain related code to be
executed frequently

16
 Brief Introduction to CAPL
Adding an Event Handler

CAPL is a procedural language in which the execution of program blocks is

controlled by events. These program blocks are referred to as event
procedures.

17
 Brief Introduction to CAPL
Important Event Handlers

on Start
{
u Start of measurement write ("Start of CANoe");
}

on message 0x123
{
u Message received write ("CAN Message 123");
}

on signal sigTemp
u Signal change {
write ("Signal Temperature");
}

on timer tmrCycle
u Time event {
write ("within cycle");
}

on key 'a'
u Key press {
write ("Key >a< pressed");
}

18
 Brief Introduction to CAPL
On Key Procedures

on key 'a' // React to press of ‘a’ key

on key ' ' // React to press of spacebar

on key 0x20 // React to press of spacebar

on key F1 // React to press of F1 key

on key ctrlF12 // React to press of Ctrl-F12

on key PageUp // React to press of Page Up key

on key Home // React to press of Home key

on key * // React to any key press except…

19
 Brief Introduction to CAPL
Data types for CAN

Type Name Bit Note

Integers Signed int 16
long 32
int64 64
Unsigned byte 8
word 16
dword 32
qword 64
Floating point float 64 Per IEEE
double 64 Per IEEE
Single character char 8
Message variable for CAN message for CAN messages
Time variables for seconds timer for Timer in s
for milliseconds mstimer for Timer in ms

20
 Brief Introduction to CAPL
Variables in CAPL

u CAPL code:
int i = 100; // Declaration and initialization of an integer
char ch = 'a'; // Declaration and initialization of a character
float x; // Declaration of a floating point number

write ("Hundred as decimal number: %d", i);

write ("Hundred as hexadecimal number: %x", i);
write ("Pi as floating point number: %f", pi);
write ("The decimal ASCII code of %c is %d", ch, ch);
write ("The value of x is %f", x);

u Results:

21
 Brief Introduction to CAPL
Operators

Operator Description Example

+ - Addition, subtraction -

* / Multiplication, division -

++ -- Increment or decrement by 1 a++; // increments a by 1

% Modulo division (returns integer a = 4 % 3; // a is 1

remainder of a division)
< <= Less than; less than or equal to returns TRUE or FALSE

> >= Greater than; greater than or equal to returns TRUE or FALSE

== != Compare for equality or inequality returns TRUE or FALSE

&& Logic AND returns TRUE or FALSE

|| Logic OR returns TRUE or FALSE

! Logic NOT changes TRUE to FALSE and vice versa

& Bitwise AND 1 & 7 // yields 1 (0001 & 0111  0001)

| Bitwise OR 1 | 7 // yields 7 (0001 | 0111  0111)

~ Bitwise complement ~1 // yields 14 (0001  1110)

^ Bitwise exclusive OR (XOR) 01^11 // ergibt 10

>> << Bit shift to right or left 1 << 3 // yields 8 (0001  1000)

22
 Agenda

Important information before getting started 3

Visual Sequencer (GUI based programming (Subset of CAPL)) 7
Brief Introduction to CAPL 11
u Notes on Panel creation and use 24
Where to find additional information 28
Contact Information 30

23
 Notes on Panel creation and use
Creating a Panel

A signal is mapped to each display or control:

Drag & Drop

24
 Notes on Panel creation and use
Creating a System Variable for use with in a configuration
Signals can be automatically or user created, saved, exported, and
imported via the Configuration|Systems Variables dialog:

25
 Agenda

Important information before getting started 3

Visual Sequencer (GUI based programming (Subset of CAPL)) 7
Brief Introduction to CAPL 11
Notes on Panel creation and use 24
u Where to find additional information 28
Contact Information 30

26
 Agenda

Important information before getting started 3

Visual Sequencer (GUI based programming (Subset of CAPL)) 7
Brief Introduction to CAPL 11
Notes on Panel creation and use 24
u Where to find additional information 28
Contact Information 30

27
 Where to find additional information
Online Help file: Use Index|CAPL Introduction

28
 Agenda

Important information before getting started 3

Visual Sequencer (GUI based programming (Subset of CAPL)) 7
Brief Introduction to CAPL 11
Notes on Panel creation and use 24
Where to find additional information 28
u Contact Information 30

29
 Contact Information
Looking for more information?

Visit our website:

> http://www.vector.com

Sign in for a Vector training class:

> http://www.vector.com/vi_training_en.html

Need help with Vector tools?

Contact our support team:

> (248) 449 – 9290 Option 2
> [email protected]

30