IFM BasicController CR0431, ioControl CR2050 Programming Manual

Programming Manual

BasicController relay

CR0431

Runtime system V03.03.00

CODESYS ® > v2.3.9.33 (< v3.0)

English

1

ifm Programming Manual BasicController relay CR0431 v03.03.00

Contents

05 / 2018

Contents

1

1.1

1.2

1.3

1.4

1.5

2

2.1

2.2

2.3

2.4

About this manual 4

Copyright .............................................................................................................................. 4

Overview: documentation modules for CR0431 .................................................................. 5

What do the symbols and formats mean? ........................................................................... 6

How is this documentation structured? ................................................................................ 7

History of the instructions (CR043n) .................................................................................. 7

Safety instructions 8

Please note .......................................................................................................................... 8

What previous knowledge is required? ................................................................................ 8

Start-up behaviour of the controller...................................................................................... 9

Notes: serial number ............................................................................................................ 9

3 System description 10

3.1

3.2

Information about the device ..............................................................................................10

Hardware description .........................................................................................................11

3.2.1

Hardware structure ..................................................................................................................... 11

3.2.2

Inputs (technology) ..................................................................................................................... 14

3.2.3

Outputs (technology) .................................................................................................................. 18

3.2.4

Note on wiring ............................................................................................................................ 20

3.2.5

Safety instructions about Reed relays ........................................................................................ 20

3.2.6

Status-LED ................................................................................................................................. 21

3.3

Interface description ...........................................................................................................22

3.3.1

CAN interfaces ........................................................................................................................... 22

3.4

Software description ..........................................................................................................23

3.4.1

Software modules for the device ................................................................................................ 23

3.4.2

Programming notes for CODESYS projects ............................................................................... 26

3.4.3

Operating states ......................................................................................................................... 29

3.4.4

Performance limits of the device ................................................................................................ 31

4 Configurations 34

4.1

Set up the runtime system .................................................................................................34

4.1.1

Reinstall the runtime system ...................................................................................................... 35

4.1.2

Update the runtime system ......................................................................................................... 36

4.1.3

Verify the installation .................................................................................................................. 36

4.2

Set up the programming system ........................................................................................37

4.2.1

Set up the programming system manually ................................................................................. 37

4.3

4.2.2

Set up the programming system via templates ........................................................................... 41

Function configuration in general .......................................................................................41

4.3.1

System variables ........................................................................................................................ 41

4.4

Function configuration of the inputs and outputs ...............................................................42

4.4.1

Configuration of the inputs (default setting) ................................................................................ 42

4.4.2

Configure inputs ......................................................................................................................... 43

4.4.3

Configure outputs ....................................................................................................................... 48

4.5

Variables ............................................................................................................................50

4.5.1

Retain variables .......................................................................................................................... 51

4.5.2

Network variables ....................................................................................................................... 52

5 ifm function elements 53

5.1

ifm libraries for the device CR0431 ....................................................................................53

5.1.1

Library ifm_CR0431_V03yyzz.LIB .............................................................................................. 54

2

9

10


Contents

05 / 2018

5.1.2

Library ifm_CR0431_util_V03yyzz.LIB ....................................................................................... 55

5.1.3

Library ifm_RAWCan_NT_Vxxyyzz.LIB...................................................................................... 55

5.1.4

Library ifm_CANopen_NT_Vxxyyzz.LIB ..................................................................................... 56

5.1.5

Library ifm_J1939_NT_Vxxyyzz.LIB ........................................................................................... 57

5.2

ifm function elements for the device CR0431 ....................................................................58

5.2.1

Function element outputs ........................................................................................................... 59

5.2.2

Function elements: RAW-CAN (Layer 2) .................................................................................... 60

5.2.3

Function elements: CANopen ..................................................................................................... 86

5.2.4

Function elements: SAE J1939 ................................................................................................ 132

5.2.5

Function elements: processing input values ............................................................................. 164

5.2.6

Function elements: output functions ......................................................................................... 175

5.2.7

Function elements: system ....................................................................................................... 182

6 Diagnosis and error handling 200

6.1

6.2

Diagnosis .........................................................................................................................200

Fault .................................................................................................................................200

6.3

Response to system errors ..............................................................................................200

6.3.1

Example process for response to an error message ................................................................ 201

6.4

CAN / CANopen: errors and error handling .....................................................................201

7 Appendix 202

7.1

System flags .....................................................................................................................202

7.1.1

System flags: voltages.............................................................................................................. 203

7.1.2

System flags: inputs and outputs .............................................................................................. 203

7.1.3

System flags: system ............................................................................................................... 203

7.2

Address assignment and I/O operating modes ................................................................204

7.2.1

Address assignment inputs / outputs ........................................................................................ 204

7.3

7.2.2

Possible operating modes inputs/outputs ................................................................................. 206

Error tables .......................................................................................................................208

7.3.1

Error flags ................................................................................................................................. 208

7.3.2

Errors: CAN / CANopen............................................................................................................ 208

8 Terms and abbreviations 210

Index

Notizen • Notes • Notes

224

228

3


About this manual

05 / 2018

Copyright

1 About this manual

>

Copyright .................................................................................................................................................. 4

Overview: documentation modules for CR0431 ....................................................................................... 5

What do the symbols and formats mean? ................................................................................................ 6

How is this documentation structured? .................................................................................................... 7

History of the instructions (CR043n) ...................................................................................................... 7

202

1.1

Copyright

6088

© All rights reserved by ifm electronic gmbh . No part of this manual may be reproduced and used without the consent of ifm electronic gmbh .

All product names, pictures, companies or other brands used on our pages are the property of the respective rights owners:

• AS-i is the property of the AS-International Association, (→ www.as-interface.net

)

• CAN is the property of the CiA (CAN in Automation e.V.), Germany (→ www.can-cia.org

)

• CODESYS™ is the property of the 3S – Smart Software Solutions GmbH, Germany (→ www.codesys.com

)

• DeviceNet™ is the property of the ODVA™ (Open DeviceNet Vendor Association), USA (→ www.odva.org

)

• EtherNet/IP ® is the property of the →ODVA™

• EtherCAT ® is a registered trade mark and patented technology, licensed by Beckhoff Automation GmbH, Germany

• IO-Link ® (→ www.io-link.com

) is the property of the →PROFIBUS Nutzerorganisation e.V., Germany

• ISOBUS is the property of the AEF – Agricultural Industry Electronics Foundation e.V., Deutschland

(→ www.aef-online.org

)

• Microsoft ® is the property of the Microsoft Corporation, USA (→ www.microsoft.com

)

• Modbus ® is the property of the Schneider Electric SE, France (→ www.schneider-electric.com

)

• PROFIBUS ® is the property of the PROFIBUS Nutzerorganisation e.V., Germany (→ www.profibus.com

)

• PROFINET ® is the property of the →PROFIBUS Nutzerorganisation e.V., Germany

• Windows ® is the property of the →Microsoft Corporation, USA

4

> ifm Programming Manual BasicController relay CR0431 v03.03.00


05 / 2018

Overview: documentation modules for CR0431

1.2

Overview: documentation modules for CR0431

The documentation for this devices consists of the following modules:

(Downloads from ifm's website → www.ifm.com

)

Document Contents / Description

Data sheet

Installation instructions

(are supplied with the device)

Technical data in a table





Instructions for installation, electrical installation, and commissioning

Technical data

Programming manual



Functions of the setup menu of the device



Creation of a CODESYS project with this device



Target settings with CODESYS



Programming of the device-internal PLC with CODESYS



Description of the device-specific CODESYS function libraries

System manual

"Know-How ecomatmobile"

Know-how about the following topics (examples):



Overview Templates and demo programs



CAN, CANopen



Control outputs



Visualisations



Overview of the files and libraries

22853

5



1.3

What do the symbols and formats mean?

The following symbols or pictograms illustrate the notes in our instructions:

WARNING

Death or serious irreversible injuries may result.

CAUTION

Slight reversible injuries may result.

NOTICE

Property damage is to be expected or may result.

→ ...

Important note

Non-compliance can result in malfunction or interference

Information

Supplementary note

► ... Request for action

> ... Reaction, result

"see" abc Cross-reference

123

0x123

0b010

[...]

Decimal number

Hexadecimal number

Binary number

Designation of pushbuttons, buttons or indications

05 / 2018

What do the symbols and formats mean?

203

6



05 / 2018

How is this documentation structured?

>

1.4

How is this documentation structured?

This documentation is a combination of different types of manuals. It is for beginners and also a reference for advanced users. This document is addressed to the programmers of the applications.

How to use this manual:



Refer to the table of contents to select a specific subject.



Using the index you can also quickly find a term you are looking for.



At the beginning of a chapter we will give you a brief overview of its contents.



Abbreviations and technical terms → Appendix.

In case of malfunctions or uncertainties please contact the manufacturer at:

Contact → www.ifm.com

We want to become even better! Each separate section has an identification number in the top right corner. If you want to inform us about any inconsistencies, indicate this number with the title and the language of this documentation. Thank you very much for your support!

We reserve the right to make alterations which can result in a change of contents of the documentation. You can find the current version on ifm's website:

→ www.ifm.com

204

1508

1.5

History of the instructions (CR043n)

What has been changed in this manual? An overview:

Date Theme

2016-04-27

2017-01-13

2018-07-09

FBs for fast inputs

Software manual for CODESYS 2.3

List of the ifm branch offices

Change

Note in case of higher frequencies added hint to download from the ifm homepage removed removed

19584

7


Safety instructions

05 / 2018

Please note

2 Safety instructions

>

Please note ............................................................................................................................................... 8

What previous knowledge is required? .................................................................................................... 8

Start-up behaviour of the controller .......................................................................................................... 9

Notes: serial number ................................................................................................................................ 9

213

2.1

Please note

6091

11779

No characteristics are warranted with the information, notes and examples provided in this manual.

With the drawings, representations and examples given no responsibility for the system is assumed and no application-specific particularities are taken into account.

► The manufacturer of the machine/equipment is responsible for ensuring the safety of the machine/equipment.

► Follow the national and international regulations of the country in which the machine/installation is to be placed on the market!

WARNING

>

Non-observance of these instructions can lead to property damage or personal injury. ifm electronic gmbh does not assume any liability in this regard.

► The acting person must have read and understood the safety instructions and the corresponding chapters in this manual before working on and with this device.

► The acting person must be authorised to work on the machine/equipment.

► The acting person must have the qualifications and training required to perform this work.

► Adhere to the technical data of the devices!

You can find the current data sheet on the ifm website.

► Note the installation and wiring information as well as the functions and features of the devices!

→ supplied installation instructions or on the ifm website.

Homepage → www.ifm.com

2.2

What previous knowledge is required?

215

This document is intended for people with knowledge of control technology and PLC programming with IEC 61131-3.

To program the PLC, the people should also be familiar with the CODESYS software.

The document is intended for specialists. These specialists are people who are qualified by their training and their experience to see risks and to avoid possible hazards that may be caused during operation or maintenance of a product. The document contains information about the correct handling of the product.

Read this document before use to familiarise yourself with operating conditions, installation and operation. Keep the document during the entire duration of use of the device.

Adhere to the safety instructions.

8


Safety instructions

05 / 2018

Start-up behaviour of the controller

2.3

Start-up behaviour of the controller

6827

15233

11575

WARNING

Danger due to unintentional and dangerous start of machine or plant sections!

► When creating the program, the programmer must ensure that no unintentional and dangerous start of machines or plant sections after a fault (e.g. e-stop) and the following fault elimination can occur!

 Realise restart inhibit.

► In case of an error, set the outputs concerned to FALSE in the program!

>

A restart can, for example, be caused by:

• Voltage restoration after power failure

• Reset after the watchdog responded because the cycle time was too long

• Error elimination after an E-stop

To ensure safe controller behaviour:

► monitor the voltage supply in the application program.

► In case of an error switch off all relevant outputs in the application program.

► Additionally monitor actuators which can cause hazardous movements in the application program

(feedback).

► Monitor relay contacts which can cause hazardous movements in the application program

(feedback).

► If necessary, ensure that welded relay contacts in the application project cannot trigger or continue hazardous movements.

2.4

Notes: serial number

20780

► In the user's production facility, draw a diagram of the controller network in the machine. Enter the serial number of each controller installed into the network diagram.

► Before downloading a software component, read out this serial number and check the network diagram to make sure that you are accessing the right controller.

9


System description

05 / 2018

Information about the device

3 System description

>

Information about the device ..................................................................................................................10

Hardware description ..............................................................................................................................11

Interface description ...............................................................................................................................22

Software description ...............................................................................................................................23

975

3.1

Information about the device

This manual describes of the ecomatmobile family for mobile machines of ifm electronic gmbh :



BasicRelay: CR0431

19587

10



05 / 2018

Hardware description

3.2

Hardware description

Hardware structure .................................................................................................................................11

Inputs (technology) .................................................................................................................................14

Outputs (technology) ..............................................................................................................................18

Note on wiring .........................................................................................................................................20

Safety instructions about Reed relays ....................................................................................................20

Status-LED .............................................................................................................................................21

14081

3.2.1

Hardware structure

Start conditions .......................................................................................................................................12

Important note to program the device ....................................................................................................12

Principle block diagram ..........................................................................................................................12

Available memory ...................................................................................................................................13

15332

11



05 / 2018


>

Start conditions

19673

The device does not start before sufficient voltage is applied to the supply connection VBB15.

In vehicles VBB15 is the plus cable switched by the ignition lock.

A voltage > 8 V is deemed sufficient.

Permissible operating voltage → data sheet

>

Relays can only be switched on again if VBBs is applied and SUPLY_SWITCH is closed.

Important note to program the device

>

Applies to the following devices:

• BasicController relay CR0431

► For the time of programming interconnect the connections B:1 (VBB15) and B:8 (VBBs).

Otherwise programming is not possible.

Background:



The controller resets all outputs when programming begins, also SUPPLY_SWITCH.



Without VBB15 the controller would be separated from the voltage supply and is switched off.



When the controller is switched on again, the device is in bootloader mode.

The programmer has to load the Basic System to the device again.

Then reload the application program to the device.

20763

Principle block diagram

19672

Figure: principle block diagram of supply and relays

12



>

Available memory

>

FLASH memory

FLASH memory (non-volatile, slow memory) overall existing in the device

Thereof the following memory areas are reserved for ... maximum size of the application program data other than the application program read data with FB

FLASH_READ

(

→ p. 184 )

(files: 128 bytes less for header)

>

The remaining rest of the memory is reserved for system internal purposes.

SRAM

SRAM (volatile, fast memory) overall existing in the device

SRAM indicates here all kinds of volatile and fast memories.

Thereof the following memory areas are reserved for ... data reserved by the application program

>


FRAM

FRAM (non-volatile, fast memory) overall existing in the device

FRAM indicates here all kinds of non-volatile and fast memories.

Thereof the following memory areas are reserved for ... variables in the application program, declared as VAR_RETAIN fixed as remanent defined flags (%MB0...127)


05 / 2018


13736

13053

1 536 kByte

128 kByte

64 kByte

208 kByte

12269

32 kByte

2 kByte

2262

128 Byte

128 Byte

13



05 / 2018


3.2.2

Inputs (technology)

>

Analogue inputs ......................................................................................................................................14

Binary inputs ...........................................................................................................................................15

Input group IN0...IN3 ..............................................................................................................................16

Input group IN4...IN7 ..............................................................................................................................16

14090

Analogue inputs

15444

The analogue inputs can be configured via the application program. The measuring range can be set as follows:

• current input 0...20 mA

• voltage input 0...10 V

• voltage input 0...32 V

• resistance measurement 16...30 000 

(measurement to GND)

The voltage measurement can also be carried out ratiometrically (0...1000 ‰, adjustable via function blocks). This means potentiometers or joysticks can be evaluated without additional reference voltage.

A fluctuation of the supply voltage has no influence on this measured value.

As an alternative, an analogue channel can also be evaluated binarily.

In case of ratiometric measurement the connected sensors should be supplied with VBBs of the device. So, faulty measurements caused by offset voltage are avoided.

8971

In = pin multifunction input n

(CR) = device

(1) = input filter

(2) = analogue current measuring

(3a) = binary-input plus switching

(3b) = binary-input minus switching

(4a) = analogue voltage measuring 0...10 V

(4b) = analogue voltage measuring 0...32 V

(5) = voltage

(6) = reference voltage

Figure: principle block diagram multifunction input

8972

Figure: block diagram of the resistor survey input

In = pin resistor survey input n

(CR) = device

(1) = input filter

(2) = constant-current source

(3) = internal resistance

(4) = voltage

14



05 / 2018


>

Binary inputs

The binary input can be operated in following modes:

• binary input plus switching (BL) for positive sensor signal

• binary input minus switching (BH) for negative sensor signal

Depending on the device the binary inputs can configured differently. In addition to the protective mechanisms against interference, the binary inputs are internally evaluated via an analogue stage.

This enables diagnosis of the input signals. But in the application software the switching signal is directly available as bit information

1015

7345

In = pin binary-input n

(CR) = device

(1) = input filter

(2a) = input minus switching

(2b) = input plus switching

(3) = voltage

Figure: basic circuit of binary input minus switching / plus switching for negative and positive sensor signals

In = pin binary input n

(S) = sensor

In = pin binary input n

(S) = sensor

Basic circuit of binary input plus switching (BL) for positive sensor signal:

Input = open  signal = low (GND)

Basic circuit of binary input minus switching (BH) for negative sensor signal:

Input = open  signal = high (supply)

For some of these inputs ( → data sheet) the potential can be selected to which it will be switched.

15



05 / 2018


>

Input group IN0...IN3

These inputs are a group of multifunction channels.

These inputs can be used as follows (each input separately configurable):

• analogue input 0...20 mA

• analogue input 0...10 V


• voltage measurement ratiometric 0...1000 ‰

• binary input plus switching (BL) for positive sensor signal (with/without diagnosis)


• fast input for e.g. incremental encoders and frequency or interval measurement

→ chapter Possible operating modes inputs/outputs (

→ p. 206 )

Sensors with diagnostic capabilities to NAMUR can be evaluated.

>

All inputs show the same behaviour concerning function and diagnosis.

Detailed description → chapter Address assignment inputs / outputs (

→ p. 204 )

Configuration of each input is made via the application program:

• FB INPUT (

→ p. 169 ) > input MODE

• FBs FASTCOUNT (

→ p. 165 ),

INC_ENCODER (

→ p. 167 ) or

PERIOD (

→ p. 171 )

> If the analogue inputs are configured for current measurement, the device switches to the safe voltage measurement range (0...32 V DC) and the output RESULT is set accordingly in the function block INPUT when the final value (23 mA for > 40 ms) is exceeded. After about one second the input automatically switches back to the current measuring range.

14568

Input group IN4...IN7

14569

These inputs are a group of multifunction channels.

These inputs can be used as follows (each input separately configurable):

• binary input plus switching (BL) for positive sensor signal

• input for resistance measurement (e.g. temperature sensors or fuel sensors)

→ chapter Possible operating modes inputs/outputs (

→ p. 206 )

Sensors with diagnostic capabilities to NAMUR can be evaluated.

► Configuration of each input is made via the application program:

• FB INPUT (


16



>

Resistance measurement

Typical sensors on these inputs:

• tank level

• temperature (PT1000, NTC)

05 / 2018


Figure: block diagram of the resistor survey input

In = pin resistor survey input n

(CR) = device

(1) = input filter

(2) = constant-current source

(3) = internal resistance

(4) = voltage

The resistance for this device is not linearly dependent on the resistance value, → figure:

9773

8972

8970

Figure: resolution dependent on the resistance value

(1) = resistance value at the input

(2) = resolution

By how many ohms does the measured value change when the signal of the A/D converter on the input changes by 1?

Examples:

• In the range of 1...100 

the resolution is 1.2



.

• In the range of 1 k 

the resolution is approx. 2



.





.





.





.









.

17



05 / 2018


3.2.3

Outputs (technology)

>

Protective functions of the outputs .........................................................................................................18

Output group K0...K5 ..............................................................................................................................18

Output group LED0...LED6.....................................................................................................................19

14093

Protective functions of the outputs

15248

>

The outputs of this device are protected against overload and short circuit within specific ranges.

→ data sheet

Fuses, relays

19676

The relay outputs are protected via fuses:

► Adapt the value of the fuses...

• to the load capacity of the relays used.

• to the load capacity of the wiring.

>

Output group K0...K5

These outputs are a group of channels with a single specified function.

These outputs have the following fixed setting:

• binary output with relay (change-over contacts)

• The outputs have no current measurement, no overload detection.

• The device measures the voltages on all relay contacts.

The measured values are also available in system flags:

x = 0...n (depending on the device)

► For the limit values please make sure to adhere to the data sheet!

19678

18



>

Output group LED0...LED6

These outputs are a group of channels with a single specified function.

These outputs have the following fixed setting:

• binary output with LED (e.g. diagnostic message)

The LED outputs can be freely used in the application.

The spatial arrangement on the device provides the following assignment:

• LED0 indicates intact fuse F0

• LED1 indicates intact fuse F1 etc.

05 / 2018


19682

19



05 / 2018


3.2.4

Note on wiring

1426

The wiring diagrams ( → installation instructions of the devices, chapter "Wiring") describe the standard device configurations. The wiring diagram helps allocate the input and output channels to the IEC addresses and the device terminals.

The individual abbreviations have the following meaning:

A

BH

Analogue input

Binary high side input: minus switching for negative sensor signal

Binary high side output: plus switching for positive output signal

BL

CYL

ENC

FRQ

H bridge

PWM

PWMi

IH

IL

Binary low side input: plus switching for positive sensor signal

Binary low side output: minus switching for negative output signal

Input period measurement

Input encoder signals

Frequency input

Output with H-bridge function

P ulsew idth m odulated signal

PWM output with current measurement

Pulse/counter input, high side: minus switching for negative sensor signal

Pulse/counter input, low side: plus switching for positive sensor signal

R Read back channel for one output

>

Allocation of the input/output channels: → Catalogue, mounting instructions or data sheet

3.2.5

Safety instructions about Reed relays

7348

For use of non-electronic switches please note the following:

Contacts of Reed relays may be clogged (reversibly) if connected to the device inputs without series resistor.

► Remedy: Install a series resistor for the Reed relay:

Series resistor = max. input voltage / permissible current in the Reed relay

Example: 32 V / 500 mA = 64 Ohm

► The series resistor must not exceed 5 % of the input resistance RE of the device input  → data sheet). Otherwise, the signal will not be detected as TRUE.

Example:

RE = 3 000 Ohm



max. series resistor = 150 Ohm

6915

20



3.2.6

Status-LED

05 / 2018


7998

The operating states are indicated by the integrated status LED (default setting).

LED colour Display

Permanently off

Description

No operating voltage

Off

Briefly on Initialisation or reset checks

Orange

Flashing with 5 Hz

(time frame = 200 ms) no runtime system loaded

Green

(time frame = 200 ms)

Flashing with 2 Hz Application = RUN

Green


Application = STOP or: no application loaded

Green

Permanently on

Flashing with 5 Hz Application = stopped because of undervoltage

Red

Red

Flashing with 10 Hz


Application = STOP with error application program is stopped

Cause: exceeded timeout of the application or visualisation:



Delete the application!



PowerOn reset

 Reload the application into the device

Red

Permanently on


Application = STOP and FATAL ERROR

Cause: software watchdog has failed

 PowerOn reset

If without success:

 Goto Bootloader

 PowerOn reset



Reload the BasicSystem into the device



Reload the application into the device

If without success:



Hardware error: send device to ifm !

>

The status LED can be changed by the programming system for the operating states STOP and RUN.

Control the LED in the application program

Via SET_LED frequency and color of the status LED can be changed in the application program.

The use of the LED function block in the application program replaces the system setting of the status LED in the RUN state.

15481

21



05 / 2018

Interface description

3.3

Interface description

CAN interfaces .......................................................................................................................................22

14098

3.3.1

CAN interfaces

>

CAN: interfaces and protocols ................................................................................................................22

14101

Connections and data → data sheet

CAN: interfaces and protocols

The devices are equipped with several CAN interfaces depending on the hardware design. Basically, all interfaces can be used with the following functions independently of each other:

• RAW-CAN (Layer 2): CAN on level 2 (→ chapter Function elements: RAW-CAN (Layer 2) (

→ p. 60 ))

• CANopen master / CANopen slave (→ chapter Function elements: CANopen (

→ p. 86 ))

• CANopen network variables (via CODESYS) (→ chapter Network variables

(

→ p. 52 ))

• SAE J1939 (for drive management, → chapter Function elements: SAE J1939 (

→ p. 132 ))

• Bus load detection

• Error frame counter

• Download interface

• 100 % bus load without package loss

14591

The following CAN interfaces and CAN protocols are available in this ecomatmobile device:

14589

15238

CAN interface CAN 1 CAN 2 CAN 3 CAN 4

Default download ID ID 127 ID 126 ID 125 ID 124

CAN protocols

CAN Layer 2

CANopen

SAE J1939

CAN Layer 2

CANopen

SAE J1939

Interface does not exist

Interface does not exist

Standard baud rate = 250 Kbits/s

All CAN interfaces can operate with all CAN protocols at the same time. The IDs used must not impair each other!

22



05 / 2018

Software description

3.4

Software description

Software modules for the device ............................................................................................................23

Programming notes for CODESYS projects ...........................................................................................26

Operating states .....................................................................................................................................29

Performance limits of the device ............................................................................................................31

14107

3.4.1

Software modules for the device

Bootloader ..............................................................................................................................................24

Runtime system ......................................................................................................................................24

Application program ................................................................................................................................24

Libraries ..................................................................................................................................................25

14110

The software in this device communicates with the hardware as below: software module Can user change the module?

By means of what tool?

Application program with libraries yes

CODESYS,

MaintenanceTool

Runtime system *)

Bootloader

(Hardware)

Upgrade yes

Downgrade yes no no

MaintenanceTool

---

---

*) The runtime system version number must correspond to the target version number in the CODESYS target system setting.

→ chapter Set up the target

(

→ p.

38 )

Below we describe this software module:

23



05 / 2018


>

Bootloader

14111

>

On delivery ecomatmobile controllers only contain the boot loader.

The boot loader is a start program that allows to reload the runtime system and the application program on the device.

The boot loader contains basic routines...

• for communication between hardware modules,

• for reloading the operating system.

The boot loader is the first software module to be saved on the device.

Runtime system

14112

Basic program in the device, establishes the connection between the hardware of the device and the application program.

→ chapter Software modules for the device (

→ p. 23 )

On delivery, there is normally no runtime system loaded in the controller (LED flashes green at 5 Hz).

Only the bootloader is active in this operating mode. It provides the minimum functions for loading the runtime system, among others support of the interfaces (e.g. CAN).

>

Normally it is necessary to download the runtime system only once. Then, the application program can be loaded into the controller (also repeatedly) without affecting the runtime system.

The runtime system is provided with this documentation on a separate data carrier. In addition, the current version can be downloaded from the website of ifm electronic gmbh :

→ www.ifm.com

Application program

14118

Software specific to the application, implemented by the machine manufacturer, generally containing logic sequences, limits and expressions that control the appropriate inputs, outputs, calculations and decisions.

8340

WARNING

The user is responsible for the reliable function of the application programs he designed. If necessary, he must additionally carry out an approval test by corresponding supervisory and test organisations according to the national regulations.

24



05 / 2018


>

Libraries

15409 ifm electronic offers several libraries ( *.LIB

) to match each device containing program modules for the application program. Examples:

Library ifm_CR0431_Vxxyyzz.LIB

Use ifm_RawCAN_NT_Vxxyyzz.LIB

ifm_CANopen_NT_Vxxyyzz.LIB

ifm_J1939_NT_Vxxyyzz.LIB

Device-specific library

Must always be contained in the application program!

(optional) when a CAN interface of the device is to be operated with CAN

Layer 2

(optional) when a CAN interface of the device is to be operated as

CANopen master or CANopen slave

(optional) when a CAN interface of the device is to communicate with a motor control

Details:

→ chapter ifm libraries for the device CR0431

(

→ p.

53 )

25



05 / 2018


3.4.2

Programming notes for CODESYS projects

>

FB, FUN, PRG in CODESYS .................................................................................................................26

Note the cycle time! ................................................................................................................................27

Important note to program the device ....................................................................................................27

Creating application program .................................................................................................................28

Using ifm maintenance tool ....................................................................................................................29

Distribution of the application program ...................................................................................................29

7426

Here you receive tips how to program the device.

► See the notes in the CODESYS programming manual.

FB, FUN, PRG in CODESYS

15410

In CODESYS we differentiate between the following types of function elements:

FB = function block

• An FB can have several inputs and several outputs.

• An FB may be called several times in a project.

• An instance must be declared for each call.

• Permitted: Call FB and FUN in FB.

FUN = function

• A function can have several inputs but only one output.

• The output is of the same data type as the function itself.

PRG = program

• A PRG can have several inputs and several outputs.

• A PRG may only be called once in a project.

• Permitted: Call PRG, FB and FUN in PRG.

NOTE

Function blocks must NOT be called in functions!

Otherwise: During execution the application program will crash.

All function elements must NOT be called recursively, nor indirectly!

An IEC application may contain maximum 8000 function elements; in this device maximum 512 function elements!

Background:

All variables of functions...

• are initialised when called and

• become invalid after return to the caller.

Function blocks have 2 calls:

• an initialisation call and

• the actual call to do something.

Consequently that means for the function block call in a function:

• every time there is an additional initialisation call and

• the data of the last call gets lost.

26



05 / 2018


>

Note the cycle time!

8006

For the programmable devices from the controller family ecomatmobile numerous functions are available which enable use of the devices in a wide range of applications.

As these units use more or fewer system resources depending on their complexity it is not always possible to use all units at the same time and several times.

NOTICE

>

Risk that the device acts too slowly!

Cycle time must not become too long!

► When designing the application program the above-mentioned recommendations must be complied with and tested.

► If necessary, the cycle time must be optimised by restructuring the software and the system set-up.

Important note to program the device

Applies to the following devices:

• BasicController relay CR0431

► For the time of programming interconnect the connections B:1 (VBB15) and B:8 (VBBs).

Otherwise programming is not possible.

Background:



The controller resets all outputs when programming begins, also SUPPLY_SWITCH.



Without VBB15 the controller would be separated from the voltage supply and is switched off.



When the controller is switched on again, the device is in bootloader mode.

The programmer has to load the Basic System to the device again.

Then reload the application program to the device.

20763

27



05 / 2018


>

Creating application program

The application program is generated by the CODESYS 2.3 programming system and loaded in the controller several times during the program development for testing:

In CODESYS: [Online] > [Login] > load the new program.

For each such download via CODESYS 2.3 the source code is translated again. The result is that each time a new checksum is formed in the controller memory. This process is also permissible for safety controllers until the release of the software.

8007

Graphics: Creation and distribution of the software

28



05 / 2018


>

Using ifm maintenance tool

8492

The ifm Maintenance Tool serves for easy transfer of the program code from the programming station to the controller. As a matter of principle each application software can be copied to the controllers using the ifm Maintenance Tool. Advantage: A programming system with CODESYS licence is not required.

>

Here you will find the current ifm Maintenance Tool:

Homepage → www.ifm.com

>

Distribution of the application program

8493

We recommend the following sequence, if the application software is to be copied to the series machine and used:



Saving the software

After completion of program development the latest version of the application program loaded in the controller using the ifm Maintenance Tool has to be read from the controller and saved on a data carrier using the name project_file.RESX

. Only this process ensures that the application software and its checksums are stored.



Download of the software.

To equip all machines of a series production with an identical software only this file may be loaded in the controllers using the ifm Maintenance Tool.



An error in the data of this file is automatically recognised by the integrated checksum when loaded again using the ifm Maintenance Tool.

3.4.3

Operating states

1075

>

After power on the ecomatmobile device can be in one of five possible operating states:

• BOOTLOADER

• INIT

• STOP

• RUN

• SYSTEM STOP

INIT state (Reset)

20647

Premise: a valid runtime system is installed.

This state is passed through after every power on reset:

> The runtime system is initialised.

> Various checks are carried out, e.g. waiting for correctly power supply voltage.

>

This temporary state is replaced by the RUN or STOP state.

>

The LED lights orange.

Change out of this state possible into one of the following states:

• RUN

• STOP

29



>

STOP state

A transition into this state is possible in the following cases:

• from the INIT state if no application program is loaded.

• From the RUN state if the following condition is met:

• The STOP command is sent via the CODESYS interface.

In the STOP state:

>

The outputs of the device are switched off.

> Processing of the application program is stopped.

> The LED lights green.

>

A transition from this state into one of the following states is possible:

• RUN

• ERROR

• FATAL ERROR

• INIT (after power-on-reset)

RUN state

05 / 2018



 from the INIT state (autostart) if the following conditions are met:

• The operating voltage has reached a minimum value. AND:

• The application program exists.



From the STOP state:

• via the CODESYS command RUN.

• The operating voltage has reached or exceeded a minimum value.

In the RUN state:

> The runtime system is running.

> The application program is running.

>

The LED flashes green with 2 Hz.

The LED can be controlled differently by the application program → FB SET_LED

(

→ p. 196 ).



• STOP

• ERROR

• FATAL ERROR

8288

8287

30



>

ERROR state


• if the supply voltage is too low.

In the ERROR state:

> The outputs of the device are switched off.

> Processing of the application program is stopped.

>

System parameters are saved.

> The LED flashed red with 5 Hz.

>



• RUN

• STOP

• FATAL ERROR

FATAL ERROR state


• memory error (RAM / Flash)

• exception error

• runtime system error

In the FATAL ERROR state:

>

The outputs of the device are switched off.

> The application program is terminated.

> The runtime system is terminated.

> The LED lights red.

>



3.4.4

Performance limits of the device

Note the limits of the device! → Data sheet

05 / 2018


8290

8289

7358

31



05 / 2018


>

Watchdog behaviour

15365

In this device, a watchdog monitors the program runtime of the CODESYS application.

If the maximum watchdog time (100 ms) is exceeded:

> the device changes to the "Timeout Error" state

> all processes are stopped (reset)

> all outputs are switched off

> the status LED flashes red at 10 Hz

Eliminate the fault:

 Delete application program!

 PowerOn reset

 Reload the application program into the device

>

If the watchdog in question fails:

> a second watchdog leads the device to the state "Fatal Error"

> the status LED lights red

Eliminate the fault:

 PowerOn reset

If without success:

 Goto Bootloader

 PowerOn reset

 Reload the runtime system into the device

 Reload the application program into the device

If without success:

 Hardware error: send device to ifm !

Limitations for CAN in this device

17975

FIFO ( F irst I n, F irst O ut) = Operating principle of the stack memory: The data packet that was written into the stack memory first, will also be read first. Each identifier has such a buffer (queue).

Some Raw-CAN function elements enable transmitting and receiving of several messages in one PLC cycle as the messages are temporarily stored in a FiFo:

- CAN_TX..., → Function elements: transmit RAW-CAN data

- CAN_RX_ENH_FIFO (

→ p. 70 )

- CAN_RX_RANGE_FIFO (

→ p. 74 )

The number of FIFo messages is limited. The following limitations of the devices are valid:

Criterion

Device BasicController: CR040n, CR041n,

CR043n

BasicDisplay: CR045n ioControl: CR205n

SmartController: CR253n

PDM360 NG: CR108n, CR120n max. FiFo transmit

- with FB CAN_TX...

- with FB CAN_TX_ENH... max. FiFo receive

- with FB CAN_RX_..._FIFO

4 messages

16 messages

32 messages

4 messages

16 messages

32 messages

32



>

Limitations for CANopen in this device

>

The following limitations of the devices are valid:

Device

Criterion max. guarding error max. SDO data

BasicController: CR040n, CR041n,

CR043n


SmartController: CR253n

32 messages

2 048 bytes

Limitations for CAN J1939 in this device

The following limitations of the devices are valid:

Device

Criterion

BasicController: CR040n, CR041n,

CR043n


SmartController: CR253n max. FiFo transmit

- with FB J1939_TX

- with FB J1939_TX_ENH max. FiFo receive

- with FB J1939_RX_FIFO max. DTCs max. data J1939

4 messages

16 messages

32 messages

64 messages

1 785 bytes

05 / 2018


PDM360 NG: CR108n, CR120n

128 messages

2 048 bytes

PDM360 NG: CR108n, CR120n

4 messages

16 messages

32 messages

64 messages

1 785 bytes

17976

17977

33


Configurations

05 / 2018

Set up the runtime system

4 Configurations

Set up the runtime system ......................................................................................................................34

Set up the programming system ............................................................................................................37

Function configuration in general ...........................................................................................................41

Function configuration of the inputs and outputs ...................................................................................42

Variables .................................................................................................................................................50

1016

The device configurations described in the corresponding installation instructions or in the Appendix

(

→ p. 202 ) to this documentation are used for standard devices (stock items). They fulfil the requested

specifications of most applications.

Depending on the customer requirements for series use it is, however, also possible to use other device configurations, e.g. with respect to the inputs/outputs and analogue channels.

4.1

Set up the runtime system

Reinstall the runtime system ..................................................................................................................35

Update the runtime system.....................................................................................................................36

Verify the installation ..............................................................................................................................36

14091

34


Configurations

05 / 2018


4.1.1

Reinstall the runtime system

14635

8486

On delivery of the ecomatmobile controller no runtime system is normally loaded (LED flashes green at 5 Hz). Only the boot loader is active in this operating mode. It provides the minimum functions for loading the operating system (e.g. RS232, CAN).

Normally it is necessary to download the runtime system only once. The application program can then be loaded to the device (also several times) without influencing the runtime system.

The runtime system is provided with this documentation on a separate data carrier. In addition, the current version can be downloaded from the website of ifm electronic gmbh :

→ www.ifm.com

8651

NOTICE

Risk of data loss!

In case of power failure during the data transmission data can be lost so that the device is no longer functionable. Repair is only possible by ifm electronic .

► Ensure an uninterrupted power supply during the data transmission!

8485

NOTE

The software versions suitable for the selected target must always be used:

• runtime system ( ifm_CR0431_Vxxyyzz.RESX

),

• PLC configuration ( ifm_CR0431_Vxx.CFG

),

• device library ( ifm_CR0431_Vxxyyzz.LIB

) and

• the further files.

V xx: 00...99 yy: 00...99 zz: 00...99 version target version number release number patch number

The basic file name (e.g. " CR0431 ") and the software version number "xx" (e.g. " 01 ") must always have the same value! Otherwise the device goes to the STOP mode.

The values for "yy" (release number) and "zz" (patch number) do not have to match.

4368

The following files must also be loaded:

• the internal libraries (created in IEC 1131) required for the project,

• the configuration files ( *.CFG

) and

• the target files ( *.TRG

).

It may happen that the target system cannot or only partly be programmed with your currently installed version of CODESYS. In such a case, please contact the technical support department of ifm electronic gmbh .


The runtime system is transferred to the device using the separate program "Maintenance Tool". (The program can be downloaded from ifm's website, if necessary):

→ www.ifm.com

Normally the application program is loaded to the device via the programming system. But it can also be loaded using the "Maintenance Tool" if it was first read from the device.

35


Configurations

05 / 2018


4.1.2

Update the runtime system

13269

An older runtime system is already installed on the device. Now, you would like to update the runtime system on the device?

14158

NOTICE

Risk of data loss!

When deleting or updating the runtime system all data and programs on the device are deleted.

► Save all required data and programs before deleting or updating the runtime system!

>

For this operation, the same instructions apply as in the previous chapter 'Reinstall the runtime system'.

4.1.3

Verify the installation

► After loading of the runtime system into the controller:

• Check whether the runtime system was transmitted correctly!

• Check whether the correct runtime system is loaded in the controller!

► 1st test:

Test with the ifm maintenance tool if the correct runtime system version was loaded:

• Read name and version of the runtime system in the device!

• Manually compare this information with the target data!

► 2nd test (optional):

Check in the application program if the correct runtime system version was loaded:

• read name and version of the runtime system in the device!

• Compare this data with the specified values!

The following FB serves for reading the data:

GET_SW_INFO

(→ p. 188 )

Delivers information about the system software of the device:

• software name,

• software version,

• build number,

• build date

► If the application detects an incorrect version of a runtime system: bring all safety functions into the safe state.

14637

36


Configurations

05 / 2018

Set up the programming system

4.2

Set up the programming system

Set up the programming system manually .............................................................................................37

Set up the programming system via templates ......................................................................................41

14461

4.2.1

Set up the programming system manually

Set up the target .....................................................................................................................................38

Activate the PLC configuration ...............................................................................................................39

CAN declaration (e.g. CR1080) ..............................................................................................................40

3963

37


Configurations

05 / 2018


>

Set up the target

13136

11379

When creating a new project in CODESYS the target file corresponding to the device must be loaded.

► Select the requested target file in the dialogue window [Target Settings] in the menu

[Configuration].

> The target file constitutes the interface to the hardware for the programming system.

> At the same time, several important libraries and the PLC configuration are loaded when selecting the target.

► If necessary, in the window [Target settings] > tab [Network functionality] > activate [Support parameter manager] and / or activate [Support network variables].

► If necessary, remove the loaded (3S) libraries or complement them by further (ifm) libraries.

► Always complement the appropriate device library ifm_CR0431_Vxxyyzz.LIB

manually!

8485

NOTE

The software versions suitable for the selected target must always be used:

• runtime system ( ifm_CR0431_Vxxyyzz.RESX

),

• PLC configuration ( ifm_CR0431_Vxx.CFG

),

• device library ( ifm_CR0431_Vxxyyzz.LIB

) and

• the further files.

V xx: 00...99 yy: 00...99 zz: 00...99 version target version number release number patch number

The basic file name (e.g. " CR0431 ") and the software version number "xx" (e.g. " 01 ") must always have the same value! Otherwise the device goes to the STOP mode.

The values for "yy" (release number) and "zz" (patch number) do not have to match.

4368

The following files must also be loaded:

• the internal libraries (created in IEC 1131) required for the project,

• the configuration files ( *.CFG

) and

• the target files ( *.TRG

).

It may happen that the target system cannot or only partly be programmed with your currently installed version of CODESYS. In such a case, please contact the technical support department of ifm electronic gmbh .


38


Configurations

05 / 2018


>

Activate the PLC configuration

10079

The PLC configuration is automatically loaded with the target system. The PLC configuration maps the contents of the file CR0431.cfg in CODESYS. Like this, the programmer has easy access to predefined system and error flags, inputs and outputs as well as to the CAN interfaces of the device.

To access the PLC configuration (e.g. CR1080):

► Click on the tab [Resources] in CoDeSys:

► Double-click on [PLC Configuration] in the left column.

>

Display of the current PLC configuration (



following figure):

> Based on the configuration the following is available in the program environment for the user:



System and error flags

Depending on the application and the application program, these flags must be processed and evaluated. Access is made via their symbolic names.



Structure of the inputs and outputs

These can be directly symbolically designated (highly recommended!) in the window [PLC

Configuration] (example → figure below) and are available in the whole project as [Global

Variables].

39


Configurations

05 / 2018


>

CAN declaration (e.g. CR1080)

10080

In the CODESYS PLC configuration you now have to declare the CAN interface(s).

► Right-click on the name of the PLC configuration. [CANopen Interface [FIX]] of the desired CAN interface.

► Click on [Append Subelement].

► Even if the device is operated as a CANopen slave: Click on [CANopen Master...]:

Info

If the device is operated as a slave, the selection [CanSlave_Device] would also be possible.

For the simpler configuration as a master, all CAN Layer 2 and network variable functions can also be used.

> The CAN parameters of the PLC configuration are displayed. Some CAN parameters are already set as default:

► If the device is operated on CAN Layer 2 or as a slave via network variables or CAN_RX /

CAN_TX:

Check whether the correct baud rate is set for the device (baud rate must be identical for all participants).

► If the device is operated as a CANopen master:

Check all parameter settings.

► Close the window [PLC Configuration].

40


Configurations

05 / 2018

Function configuration in general

>

► In the menu [File] > [Save as ...] give a sensible name to the project and save it in the requested directory.

► In the application program always call an own instance of the FB CANOPEN_ENABLE (

→ p. 87 )

for every CAN interface!

4.2.2

Set up the programming system via templates

13745 ifm offers ready-to-use templates (program templates), by means of which the programming system can be set up quickly, easily and completely.

970

>

When installing the ecomatmobile DVD "Software, tools and documentation", projects with templates have been stored in the program directory of your PC:

…\ifm electronic\CoDeSys V…\Projects\Template_DVD_V…

► Open the requested template in CODESYS via:

[File] > [New from template…]

>

CODESYS creates a new project which shows the basic program structure. It is strongly recommended to follow the shown procedure.

4.3

Function configuration in general

3971

>

4.3.1

System variables

All system variables ( → chapter System flags (

→ p. 202 )) have defined addresses which cannot be

shifted.

15576

41


Configurations

05 / 2018

Function configuration of the inputs and outputs

4.4

Function configuration of the inputs and outputs

>

Configuration of the inputs (default setting) ............................................................................................42

Configure inputs .....................................................................................................................................43

Configure outputs ...................................................................................................................................48

7995

1394

For some devices of the ecomatmobile controller family, additional diagnostic functions can be activated for the inputs and outputs. So, the corresponding input and output signal can be monitored and the application program can react in case of a fault.

Depending on the input and output, certain marginal conditions must be taken into account when using the diagnosis:

► It must be checked by means of the data sheet if the device used has the described input and output groups ( → data sheet).



Constants are predefined (e.g. IN_DIGITAL_H) in the device libraries ( ifm_CR0431_Vxxyyzz.LIB

) for the configuration of the inputs and outputs.

For details → Possible operating modes inputs/outputs (

→ p. 206 ).

4.4.1

Configuration of the inputs (default setting)



All inputs are in the binary mode (positive switching!) when delivered.



The diagnostic function is not active.

19686

42


Configurations

05 / 2018


4.4.2

Configure inputs

>

Safety instructions about Reed relays ....................................................................................................43

Analogue inputs: configuration and diagnosis ........................................................................................44

Binäry inputs: configuration and diagnosis .............................................................................................46

Fast inputs ..............................................................................................................................................47

3973

Valid operating modes → chapter Possible operating modes inputs/outputs (

→ p. 206 )

Safety instructions about Reed relays

7348

For use of non-electronic switches please note the following:

6915

Contacts of Reed relays may be clogged (reversibly) if connected to the device inputs without series resistor.

► Remedy: Install a series resistor for the Reed relay:

Series resistor = max. input voltage / permissible current in the Reed relay

Example: 32 V / 500 mA = 64 Ohm

► The series resistor must not exceed 5 % of the input resistance RE of the device input  → data sheet). Otherwise, the signal will not be detected as TRUE.

Example:

RE = 3 000 Ohm



max. series resistor = 150 Ohm

43


Configurations

05 / 2018


>

Analogue inputs: configuration and diagnosis


• FB INPUT (


► If the analogue inputs are configured for current measurement, the device switches to the safe voltage measurement range (0...32 V DC) and the output RESULT is set accordingly in the function block INPUT when the final value (23 mA for > 40 ms) is exceeded. After about one second the input automatically switches back to the current measuring range.

As an alternative, an analogue channel can also be evaluated binarily.

14656

8971

In = pin multifunction input n

(CR) = device

(1) = input filter

(2) = analogue current measuring

(3a) = binary-input plus switching

(3b) = binary-input minus switching

(4a) = analogue voltage measuring 0...10 V

(4b) = analogue voltage measuring 0...32 V

(5) = voltage

(6) = reference voltage

Figure: principle block diagram multifunction input

44


Configurations

05 / 2018


>

Configure the software filters of the inputs

15418

Via the input FILTER in the FB INPUT (

→ p. 169 ) a software filter can be configured which filters the

measured input voltage at the analogue inputs.

The filter behaves like a low-pass filter; the filter frequency is set with the value entered in FILTER. For

FILTER, values from 0...8 are permitted.

Table: limit frequency software low-pass filter at the analogue input

FILTER Filter frequency [Hz]

0…70 %

Step response [ms] for ...

0…90 % 0…99 %

Remarks

3

4

5

6

7

0

1

2

Filter deactivated

120

47

22

10

5

2.5

1.2

10

19

38

2

5

77

154

8 0.7 308 589

The following statements of the step response are relevant:

• Input analogue: 0...90 % and 0...99 %

• Input binary: 0...70 %

18

36

73

4

9

147

294

7

17

35

72

146

293

588

1177 recommended

Figure: course of time binary signal at the input upon switch-on / switch-off

45


Configurations

05 / 2018


>

Binäry inputs: configuration and diagnosis

19689


• FB INPUT (


MODE BYTE operating mode of the input channel:

0 = 0x00 off

3 = 0x03 voltage input

6 = 0x06 voltage input, ratiometric

7 = 0x07 current input


0…10 000 mV

0...1 000 ‰

0…20 000 µA

0…32 000 mV

>

11 = 0x0B

(only for analogue evaluated inputs) binary input, plus switching (BL) with diagnosis

(Namur)

12 = 0x0C binary input, minus switching (BH)

18 = 0x12 resistance input 16...30 000 Ω

Activation of the input diagnosis

7352

If the diagnosis is to be used, it needs to be activated additionally.

► Set the mode of the input via input MODE of the function block INPUT

(

→ p. 169 ).

> The FB INPUT (

→ p. 169 ) provides the diagnostic messages of the inputs on its RESULT output.

NAMUR diagnosis for binary signals of non-electronic switches:

► Equip the switch with an additional resistor connection!

Figure: non-electronic switch S at input Inn

Sensors with diagnostic capabilities to NAMUR can be used on these inputs.

In this case, no additional resistor connection is required.

46


Configurations

05 / 2018


>

Fast inputs

8292

The devices dispose of fast counting/pulse inputs for an input frequency up to 30 kHz ( → data sheet).

14677

If, for example, mechanical switches are connected to these inputs, there may be faulty signals in the controller due to contact bouncing.

Appropriate function blocks are e.g.:

FASTCOUNT

(→ p. 165 )

Counter block for fast input pulses

INC_ENCODER

(→ p. 167 )

PERIOD

(→ p. 171 )

Up/down counter function for the evaluation of encoders

Measures the frequency and the cycle period (cycle time) in [µs] at the indicated channel

>

When using these units, the parameterised inputs and outputs are automatically configured, so the programmer of the application does not have to do this.

Use as binary inputs

3804

The permissible high input frequencies also ensure the detection of faulty signals, e.g. bouncing contacts of mechanical switches.

► If required, suppress the faulty signals in the application program!

47


Configurations

05 / 2018


4.4.3

Configure outputs

>

Configure the software filters of the outputs ...........................................................................................48

Relay outputs ..........................................................................................................................................49

LED outputs ............................................................................................................................................49

3976

Valid operating modes → chapter Possible operating modes inputs/outputs

(

→ p. 206 )

Configure the software filters of the outputs

15421

Via the input FILTER in the FB OUTPUT (

→ p. 176 ) a software filter can be configured which filters the

measured output current at the PWM outputs.

The FILTER byte is only valid for outputs with current measurement.

For outputs without current measurement: set FILTER = 0!

The current at the output is averaged over a PWM period.

If dithering is set, the current is averaged over the dither period.

The filter behaves like a low-pass filter; the limit frequency is set by the value entered in FILTER. For

FILTER, values from 0...8 are permitted.

Table: limit frequency software low-pass filter on PWM output

FILTER Filter frequency [Hz]

0…90 %

Step response [ms] for ...

0…95 % 0…99 %

Remarks

0

1

2

3

6

7

4

5

Filter deactivated

600

233

109

52

26

13

6

0.8

1.8

3.6

7.2

14.6

29.4

58.8

1.0

2.2

4.6

9.4

19.0

38.2

76.4

8 4 117.8 153.2

The following statements of the step response are relevant:

• Output current: 0...90 % and 0...99 %

1.4

3.4

7.0

14.4

29.2

58.6

117.6

235.4 outputs without current measurement recommended

Figure: time sequence binary current signal on output upon switch-on / switch-off

48


Configurations

05 / 2018


>

Relay outputs

The following operating modes are possible for the device outputs ( → data sheet):

• binary output with relay (change-over contacts)

• PWM output, plus switching (BH) without diagnostic function

Figure: Block diagram relay output x = 0...n (depending on the device)

19693

>

Configuration of each output is made via the application program:

Binary output → FB OUTPUT (

→ p. 176 )> input MODE

PWM output: → FB PWM1000

(

→ p. 178 ) (permissible PWM frequency = 15...25 kHz)

Relay output → FB RELAY (

→ p. 180 )

LED outputs

The LED outputs cannot be configured.

19695

49


Configurations

05 / 2018

Variables

4.5

Variables

Retain variables ......................................................................................................................................51

Network variables ...................................................................................................................................52

3130

In this chapter you will learn more about how to handle variables.

14486

The device supports the following types of variables:

Declaration place Validity area Variable local local retain global global retain in the declaration part of the function element (POU)

Only valid in the function element

(POU) where it was configured.

In [Resources] > [Global Variables] >

[Globale_Variables]:

Valid in all function elements of this

CODESYS project.

Memory behaviour volatile nonvolatile volatile nonvolatile

Network

In [Resources] > [Global Variables] > declaration list

Values are available to all CODESYS projects in the whole network if the variable is contained in its declaration lists. volatile nonvolatile Network retain

→ CODESYS programming manual

50


Configurations

4.5.1

Retain variables

Retain variables can be saved automatically in a protected memory area and be reloaded automatically during a reboot.

Typical applications for retain variables are for example:

• operating hours which are counted up and retained while the machine is in operation,

• position values of incremental encoders,

• preset values entered in the monitor,

• machine parameters, i.e. all variables whose values must not get lost when the device is switched off.

All variable types, also complex structures (e.g. timers), can be declared as retain.

► To do so, activate the control field [RETAIN] in the variable declaration (→ window).

05 / 2018

Variables

8672

14166

>

Save retain variables

9853

In the device the data type RETAIN is only stored in the volatile memory (RAM) during the runtime.

To save the data permanently, at the end of each cycle they are automatically be saved in the FRAM memory ¹).

¹) FRAM indicates here all kinds of non-volatile and fast memories.

NOTE

>

In this device, do NOT use the following functions from the 3S library SysLibPlcCtrl.lib

:

- FUN SysSaveRetains

- FUN SysRestoreRetains

Read back retain variables

9854

After power on and before the first program cycle the device automatically writes the saved data back to the working memory once. To do so, no additional FBs must be integrated into the application program.

NOTE

In this device, do NOT use the following functions from the 3S library SysLibPlcCtrl.lib

:

- FUN SysSaveRetains

- FUN SysRestoreRetains

51


Configurations

05 / 2018

Variables

4.5.2

Network variables

15242

9856

Global network variables are used for data exchange between controllers in the network. The values of global network variables are available to all CODESYS projects in the whole network if the variables are contained in their declaration lists.

► Integrate the following library/libraries into the CODESYS project:

 3S_CANopenNetVar.lib

 ifm_NetVarLib_NT_Vxxyyzz.lib

52


ifm function elements

05 / 2018 ifm libraries for the device CR0431

5 ifm function elements

ifm libraries for the device CR0431 ........................................................................................................53

ifm function elements for the device CR0431.........................................................................................58

13586

All CODESYS function elements (FBs, PRGs, FUNs) are stored in libraries. Below you will find a list of all the ifm libraries you can use with this device.

This is followed by a description of the function elements, sorted by topic.

5.1

ifm libraries for the device CR0431

Library ifm_CR0431_V03yyzz.LIB .........................................................................................................54

Library ifm_CR0431_util_V03yyzz.LIB ...................................................................................................55

Library ifm_RAWCan_NT_Vxxyyzz.LIB .................................................................................................55

Library ifm_CANopen_NT_Vxxyyzz.LIB .................................................................................................56

Library ifm_J1939_NT_Vxxyyzz.LIB ......................................................................................................57

14235

53




5.1.1

Library ifm_CR0431_V03yyzz.LIB

This is the device library. This ifm library contains the following function blocks:

Function element

FASTCOUNT

(→ p. 165 )

FLASH_INFO

(→ p. 183 )

FLASH_READ

(→ p. 184 )

GET_APP_INFO

(→ p. 185 )

GET_HW_INFO

(→ p. 186 )

GET_IDENTITY

(→ p. 187 )

GET_SW_INFO

(→ p. 188 )

GET_SW_VERSION

(→ p. 189 )

INC_ENCODER

(→ p. 167 )

INPUT

(→ p. 169 )

MEM_ERROR

(→ p. 190 )

MEMCPY

(→ p. 191 )

OHC

(→ p. 193 )

OUTPUT

(→ p. 176 )

PERIOD

(→ p. 171 )

PWM1000

(→ p. 178 )

SET_IDENTITY

(→ p. 195 )

SET_LED

(→ p. 196 )

SET_PASSWORD

(→ p. 198 )

TIMER_READ_US

(→ p. 199 )

Short description

Counter block for fast input pulses

Reads the information from the user flash memory:

• name of the memory area (user defined),


• start address (for simple reading with IEC structure) transfers different data types directly from the flash memory to the RAM

Delivers information about the application program stored in the device:

• name of the application,

• version of the application,

• unique CODESYS build number,

• CODESYS build date

Delivers information about the device hardware:

• ifm article number (e.g. CR0403),

• article designation,

• unambiguous serial number,

• hardware revision,

• production date

Reads the identification of the application stored in the device

(has previously been saved by means of SET_IDENTITY

(→ p. 195 ))

Delivers information about the system software of the device:

• software name,


• build number,

• build date

Delivers information about the software versions stored in the device:

• BasicSystem version,

• bootloader version,

• SIS version,

• application program version,

• user flash version


Assigns an operating mode to an input channel

Provides the current state of the selected channel

Signals errors in some parameters or in the memory

(Re-)initialisation of system resources

Writes and reads different data types directly in the memory

Adjustable operating hours counter (0...3)

Assigns an operating mode to an output channel


Measures the frequency and the cycle period (cycle time) in [µs] at the indicated channel

Initialises and configures a PWM-capable output channel the mark-to-space ratio can be indicated in steps of 1 ‰

Sets an application-specific program identification

Change the frequency and color of the status LED in the application program

Sets a user password for access control to program and memory upload

Reads out the current system time in [µs]

Max. value = 1h 11min 34s 967ms 295µs

19699

54




5.1.2

Library ifm_CR0431_util_V03yyzz.LIB

19735

This ifm library contains the following function blocks:

>


RELAY

(→ p. 180 )

STATUS_F_V_EXT

(→ p. 174 )

Short description switches the relay of the selected output channel with an adjustable voltage determines the status of the fuse for the potential V_EXT

5.1.3

Library ifm_RAWCan_NT_Vxxyyzz.LIB

14715



CAN_ENABLE

(→ p. 61 )

CAN_RECOVER

(→ p. 62 )

CAN_REMOTE_REQUEST

(→ p. 83 )

CAN_REMOTE_RESPONSE

(→ p. 84 )

CAN_RX

(→ p. 67 )

CAN_RX_ENH

(→ p. 68 )

CAN_RX_ENH_FIFO

(→ p. 70 )

CAN_RX_RANGE

(→ p. 72 )

CAN_RX_RANGE_FIFO

(→ p. 74 )

CAN_SETDOWNLOADID

(→ p. 63 )

CAN_STATUS

(→ p. 64 )

CAN_TX

(→ p. 77 )

CAN_TX_ENH

(→ p. 78 )

CAN_TX_ENH_CYCLIC

(→ p. 80 )


Initialises the indicated CAN interface

Configures the CAN baud rate

Activate / deactivate the automatic bus off handling

Restart the CAN interface in case of bus off

Send a corresponding request and return the response of the other device as a result

Provides data to the CAN controller in the device which is automatically sent as a response to the request of a remote message

Configures a data receive object and reads out the receive buffer of the data object

• Configures a data receive object and reads out the receive buffer of the data object

• Frame type and mask can be selected

• Configures a data receive object and reads out the receive buffer of the data object


• Several CAN messages per cycle possible

• Configures a range of data receive objects and reads out the receive buffer of the data objects


• Configures a range of data receive objects and reads out the receive buffer of the data objects


• Several CAN messages per cycle possible

= Set CAN download ID

Sets the download identifier for the CAN interface

Get status information on the CAN bus selected:

BAUDRATE, DOWNLOAD_ID, BUSOFF, WARNING_RX, WARNING_TX, VERSION, BUSLOAD and reset if required: BUSOFF, WARNING_RX, WARNING_TX

Transfers a CAN data object (message) to the configured CAN interface for transmission at each call

Transfers a CAN data object (message) to the configured CAN interface for transmission at each call

CAN-specific characteristics can be set

Cyclically transfers a CAN data object (message) to the configured CAN interface for transmission

CAN-specific characteristics can be set

55




5.1.4

Library ifm_CANopen_NT_Vxxyyzz.LIB

14914



CANOPEN_ENABLE

(→ p. 87 )

CANOPEN_GETBUFFERFLAGS

(→ p. 89 )

CANOPEN_GETEMCYMESSAGES

(→ p. 126 )

CANOPEN_GETERRORREGISTER

(→ p. 128 )

CANOPEN_GETGUARDHBERRLIST

(→ p. 122 )

CANOPEN_GETGUARDHBSTATSLV

(→ p. 123 )

CANOPEN_GETNMTSTATESLAVE

(→ p. 96 )

CANOPEN_GETODCHANGEDFLAG

(→ p. 100 )

CANOPEN_GETSTATE

(→ p. 91 )

CANOPEN_GETSYNCSTATE

(→ p. 118 )

CANOPEN_NMTSERVICES

(→ p. 97 )

CANOPEN_READOBJECTDICT

(→ p. 101 )

CANOPEN_SDOREAD

(→ p. 105 )

CANOPEN_SDOREADBLOCK

(→ p. 107 )

CANOPEN_SDOREADMULTI

(→ p. 109 )

CANOPEN_SDOWRITE

(→ p. 111 )

CANOPEN_SDOWRITEBLOCK

(→ p. 113 )

CANOPEN_SDOWRITEMULTI

(→ p. 115 )

CANOPEN_SENDEMCYMESSAGE

(→ p. 130 )


Initialises the indicated CANopen master interface

Configures the CAN baud rate

= CANopen get buffer flags

Provides information on the buffer flags

The flags can be reset via the optional inputs.

= Get CANopen emergency messages

Lists all emergency messages that have been received by the controller from other nodes in the network since the last deletion of messages

The list can be reset by setting the according input.

= Get CANopen error register

Reads the error registers 0x1001 and 0x1003 from the controller

The registers can be reset by setting the respective inputs.

= get CANopen guard and heartbeat error list

Lists all nodes in an array for which the master has detected an error: guarding error, heartbeat error

The list can be reset by setting the according input.

= CANopen slave get guard and heartbeat state

Signals the following states to the controller in slave operation: node guarding monitoring, heartbeat monitoring

The signalled errors can be reset by setting the respective input.

= CANopen slave get network management state

Signals the network operating status of the node

= Get object directory changed flag

Reports any change of value for a particular object directory entry

= CANopen set state

Request the parameters of the master, a slave device or a specific node in the network

= CANopen get SYNC state

• Reads the setting of the SYNC functionality (active / not active),

• reads the error state of the SYNC functionality (SyncError)

= CANopen network management services

Updates the internal node status and, depending on the NMT command entries:

• triggers an NMT command or

• triggers the initialisation of a node

= CANopen read object directory

Reads configuration data from the object directory of the device

= CANopen read SDO

Reads an "Expedited SDO" = Expedited Service Data Object

= CANopen read SDO block

Reads the indicated entry in the object directory of a node in the network via SDO block transfer

= CANopen read SDO multi

Reads the indicated entry in the object directory of a node in the network

= SDO write

Writes an "Expedited SDO" = Expedited Service Data Object

= CANopen write SDO block

Writes in the indicated entry in the object directory of a node in the network via SDO block transfer

= CANopen write SDO multi

Writes in the indicated entry in the object directory of a node in the network

= CANopen send emergency message

Sends an EMCY message. The message is assembled from the according parameters and entered in register 0x1003

56





CANOPEN_SETSTATE

(→ p. 93 )

CANOPEN_SETSYNCSTATE

(→ p. 120 )

CANOPEN_WRITEOBJECTDICT

(→ p. 102 )


= CANopen set state

Set the parameters of the master, a slave device or a specific node in the network

= CANopen set SYNC state

Switch the SYNC functionality on and off

= CANopen write object directory

Writes configuration data into the object directory of the device

>

5.1.5

Library ifm_J1939_NT_Vxxyyzz.LIB

14912



J1939_DM1RX

(→ p. 157 )

J1939_DM1TX

(→ p. 159 )

J1939_DM1TX_CFG

(→ p. 162 )

J1939_DM3TX

(→ p. 163 )

J1939_ENABLE

(→ p. 133 )

J1939_GETDABYNAME

(→ p. 135 )

J1939_NAME

(→ p. 137 )

J1939_RX

(→ p. 144 )

J1939_RX_FIFO

(→ p. 145 )

J1939_RX_MULTI

(→ p. 147 )

J1939_SPEC_REQ

(→ p. 141 )

J1939_SPEC_REQ_MULTI

(→ p. 142 )

J1939_STATUS

(→ p. 139 )

J1939_TX

(→ p. 149 )

J1939_TX_ENH

(→ p. 150 )

J1939_TX_ENH_CYCLIC

(→ p. 152 )

J1939_TX_ENH_MULTI

(→ p. 154 )


J1939 Diagnostic Message 1 RX

Receives diagnostic messages DM1 or DM2 from other ECUs

J1939 Diagnostic Message 1 TX

Transmit an active error message to the CAN stack

J1939 Diagnostic Message 1 TX configurable

CAN stack does not send cyclic DM1 "zero active faults" messages

J1939 Diagnostic Message 3 TX

Deletes inactive DTCs (DM2) on a device

Initialises the J1939 stack

= Get destination arbitrary name

Determine the target address of one or several participants by means of the name information

Give the device a name for identification in the network

Receives a single frame message

Shows the message last read on the CAN bus

= J1939 RX with FIFO

Receives all specific messages and successively reads them from a FiFo

= J1939 RX multiframe message

Receives multiframe messages

= J1939 specific request

Requests and receives a specific message from another controller

= J1939 specific request multiframe message

Requests and receives a specific multiframe message from another controller

Shows relevant information on the J1939 stack

Sends individual single frame messages

= J1939 TX enhanced

Sends individual single frame messages

Can also be set: transmission priority, data length

= J1939 TX enhanced cyclic

Cyclically sends single frame messages

Can also be set: transmission priority, data length, period

= J1939 TX enhanced Multiframe Message

Sends individual multiframe messages

57



05 / 2018 ifm function elements for the device CR0431

5.2

ifm function elements for the device CR0431

Function element outputs .......................................................................................................................59

Function elements: RAW-CAN (Layer 2) ...............................................................................................60

Function elements: CANopen ................................................................................................................86

Function elements: SAE J1939 ............................................................................................................132

Function elements: processing input values ........................................................................................164

Function elements: output functions .....................................................................................................175

Function elements: system ...................................................................................................................182

13988

3826

Here you will find the description of the ifm function elements suitable for this device, sorted by topic.

58



5.2.1

Function element outputs

Some function elements return a RESULT message.

Possible results for RESULT:

Value dec | hex

Description

0 00

7

8

14

5

6

1

4

15

1...31

07

08

0E

01

04

05

06

0F

32

10

...63

64

10

…127

128

10

...255

FB is inactive

Global return values; examples:

FB execution completed without error

– data is valid

FB is being processed – data is cyclically processed

FB is being processed

– still receiving

FB is being processed – still sending

FB is being processed – remote for ID active function block is active

FB is active

CANopen manager configures devices and sends SDOs

FB is active

CANopen manager is started

FB specific return values

FB specific error messages

Global error messages; examples:

238

239

240

241

242

247

250

252

253

255

EE

EF

F0

F1

F2

F7

FA

FC

FD

FF

Error: CANopen configuration is too large and cannot be started

Error: CANopen manager could not be started

Error: several modal inputs are active e.g. CANopen NTM services

Error: CANopen state transition is not permitted

Error: setting is not possible

Error: memory exceeded (length larger than array)

Error: FiFo is full – data was lost

Error: CAN multiframe transmission failed

Error: CAN transmission failed.

Data cannot be sent.

Error: not enough memory available for the consuming multiframe


8354

7556

59




5.2.2

Function elements: RAW-CAN (Layer 2)

Function elements: RAW-CAN status ....................................................................................................60

Function elements: receive RAW-CAN data ..........................................................................................66

Function elements: transmit RAW-CAN data .........................................................................................76

Function elements: RAW-CAN remote ...................................................................................................82

15051

Here we describe the RAW-CAN function blocks (CAN Layer 2) of ifm electronic to be used in the application program.

Function elements: RAW-CAN status

CAN_ENABLE ........................................................................................................................................61

CAN_RECOVER ....................................................................................................................................62

CAN_SETDOWNLOADID ......................................................................................................................63

CAN_STATUS ........................................................................................................................................64

15049

60



>

CAN_ENABLE

Unit type = function block (FB)

Unit is contained in the library ifm_RawCAN_NT_Vxxyyzz.LIB

Symbol in CODESYS:


7492

>

Description

7494

>

With CAN_ENABLE the CAN hardware is initialised. Without this call no other calls are possible in

RAW-CAN or they return an error.

In order to change the baud rate the following procedure is required:

► Maintain the function block on ENABLE=FALSE for the duration of one cycle.

> All protocols are reset.

>

Re-initialisation of the CAN interface and the CAN protocols running on it. Any information available for cyclical transmission is lost as well and must be newly created.

>

At renewed ENABLE=TRUE, the new baud rate is adopted.

Parameters of the inputs

7495

Parameter

ENABLE

CHANNEL

BAUDRATE

Data type

BOOL := FALSE

BYTE

WORD := 250

Description

TRUE: enable CAN interface

FALSE: disable CAN interface

CAN interface (1...n) depending on the device

Baudrate [kbits/s] permissible = 20, 50, 100, 125, 250, 500, 1000

>

Parameters of the outputs

8530

Parameter

RESULT

Data type

BYTE

Description feedback of the function block

(possible messages → following table)


Value dec | hex

Description

8

9

0

1

242

00

01

08

09

F2

FB is inactive

FB execution completed without error – data is valid function block is active

CAN is not active


61



CAN_RECOVER





7512

>

Description

7513

CAN_RECOVER has the following tasks:

 to activate / deactivate the automatic bus off handling

 to restart the CAN interface in case of bus off

> In case of bus off: CAN Controller deletes all buffers (including the buffers of the other protocols).

>

If CAN_RECOVER is not used (ENABLE=FALSE):

> in case of a bus off a recovery attempt is automatically made after 1 s.

> after 4 failed recovery attempts in a row the affected CAN interface is deactivated.


7514

Parameter

ENABLE

CHANNEL

RECOVER_EXECUTE

Data type

BOOL := FALSE

BYTE

BOOL

TIME := T#1s

Description

TRUE: No automatic recovery after CAN bus off

FALSE: Automatic recovery after CAN bus off


TRUE (only for 1 cycle): restart of CAN interface remedy bus off condition

FALSE: function element is not executed

Waiting time between bus off and restart of the CAN interface InhibitTime

(optional use of the parameter)

62



CAN_SETDOWNLOADID

= Set download ID





7516

>

Description

>

The download ID is required for data exchange when connecting the runtime system and the

CODESYS development environment. When the device is started the download ID is set with the default value from the hardware configuration.

With CAN_SETDOWNLOADID this value can be set in the PLC program (e.g. using certain inputs).

The changed ID is also written into the hardware configuration.

7517


7519

Parameter

EXECUTE

CHANNEL

DOWNLOAD_ID

Data type

BOOL := FALSE

BYTE

BYTE

Description

FALSE  TRUE (edge): execute function element once otherwise: function element is not active

A function element already started is processed.


1...127 = set download ID

0 = read download ID

>


7520

Parameter

RESULT

Data type

BYTE




0

Value dec | hex

00

Description

FB is inactive

1

8

242

01

08

F2 function block execution completed without error function block is active


63



CAN_STATUS





7499

>

Description

>

CAN_STATUS provides information on the chosen CAN bus.

Without hardware initialisation the following flags can be reset to FALSE:

- BUSOFF

- WARNING_RX

- WARNING_TX


Parameter

ENABLE

CHANNEL

CLEAR

Data type

BOOL := FALSE

BYTE

BOOL := FALSE

Description

TRUE: execute this function element

FALSE: unit is not executed

> Function block inputs are not active

> Function block outputs are not specified


TRUE: Reset the following flags:

• WARNING_RX

• WARNING_TX

• BUSOFF


7501

7502

64



>



Parameter

BAUDRATE

DOWNLOAD_ID

BUSOFF

WARNING_RX

WARNING_TX

VERSION

BUSLOAD

RESULT

Data type

WORD

BYTE

BOOL

BOOL

BOOL

DWORD

BYTE

BYTE


Value dec | hex

Description

8

9

0

1

242

00

01

08

09

F2

FB is inactive function block execution completed without error function block is active

CAN is not active


Description current baudrate of the CANopen node in [kBaud] current download ID

Error CAN BUS OFF at the interface

Warning threshold for receiving is exceeded at the interface

Warning threshold for transmitting is exceeded at the interface

Version of the ifm CAN stack library

Current bus load in [%] feedback of the function block


7504

65




Function elements: receive RAW-CAN data

CAN_RX .................................................................................................................................................67

CAN_RX_ENH .......................................................................................................................................68

CAN_RX_ENH_FIFO .............................................................................................................................70

CAN_RX_RANGE ..................................................................................................................................72

CAN_RX_RANGE_FIFO ........................................................................................................................74

15050

66



CAN_RX





7586

>

Description

7588

>

CAN_RX is used for receiving a message.

The FB limits itself to a few functions and the required memory space is low.

CAN_RX filters for the set identifier. If several CAN messages with the same identifier are received in one cycle, only the last / latest message is available.


7589

Parameter

ENABLE

CHANNEL

ID

Data type

BOOL

BYTE

DWORD

Description






Number of the data object identifier: normal frame (2 048 IDs):

0...2 047 = 0x0000 0000...0x0000 07FF extended Frame (536 868 864 IDs):

2 048...536 870 911 = 0x0000 0800...0x1FFF FFFF

>


7590

Parameter

DATA

RESULT

Data type

ARRAY [0..7] OF BYTE

BYTE

Description received data, (1...8 bytes) feedback of the function block



Value dec | hex

Description

5

9

0

1

242

00

01

05

09

F2

FB is inactive function block execution completed without error


– still receiving

CAN is not active


67



CAN_RX_ENH

= CAN RX enhanced





7606

>

Description

In addition, CAN_RX_ENH provides the following possibilities (as opposed to CAN_RX (

→ p. 67 )):

• select the frame type (11 or 29 bits),

• define a mask for the evaluation of the CAN ID.

Bit comparison of

ID and mask:

If ID_MASK-Bit = 0, then CAN-ID-Bit may be = 0 or 1.

If ID_MASK-Bit = 1, then CAN-ID-Bit must be = ID-Bit.

>

With the mask several identifiers can be defined as filters.

Example:

ID = 0x100 = 0b0001 0000 0000

Result

ID_MASK = 0x1F1 = 0b0001 1111 0001

The CAN IDs with the following bit pattern are evaluated:

0bxxx1 0000 xxx0 (x = any), i.e. for this example (all in [hex]):

100, 102, 104, 106, 108, 10A, 10C, 10E,

300, 302, 304, 306, 308, 30A, 30C, 30E,

500, 502, 504, 506, 508, 50A, 50C, 50E,

700, 702, 704, 706, 708, 70A, 70C, 70E


7608

7609

Parameter

ENABLE

CHANNEL

ID

Extended


ID_Mask


Data type

BOOL

BYTE

DWORD

BOOL := FALSE

DWORD := 0

Description







0...2 047 = 0x0000 0000...0x0000 07FF extended Frame (2 29 IDs):

0...536 870 911 = 0x0000 0000...0x1FFF FFFF

TRUE: extended Frame (ID = 0...2

29 -1)

FALSE: normal Frame (ID = 0...2

11 -1) filter mask for the identifier: if ID_MASK bit = 0, CAN ID bit may be = 0 or 1 if ID_MASK bit = 1, CAN ID bit must be = ID bit

68



>



Parameter

MATCHED_ID

DATALENGTHCOUNT

DATA

RESULT

Data type

DWORD

BYTE


BYTE


Value dec | hex

Description

5

9

0

1

242

00

01

05

09

F2



– still receiving

CAN is not active


Description number of the data object identifier

= Data Length Count number of the data bytes received received data, (1...8 bytes) feedback of the function block


7613

69



CAN_RX_ENH_FIFO

= CAN RX enhanced with FiFo





7615

>

Description

In addition, CAN_RX_ENH_FIFO provides a FiFo for the received data (as opposed to CAN_RX_ENH

(

→ p. 68 )). Thus several CAN messages can be received in one cycle.

7616

No overwriting takes place when the FiFo is full. Inbound messages will be lost.

>

In this event:

► Deactivate and reactive the FB via ENABLE.

> The FiFo is deleted and can be newly filled.

Description to the filter mask: → CAN_RX_ENH (

→ p. 68 ) > chapter

Description


7609

Parameter

ENABLE

CHANNEL

ID

Extended


ID_Mask


Data type

BOOL

BYTE

DWORD

BOOL := FALSE

DWORD := 0

Description








0...536 870 911 = 0x0000 0000...0x1FFF FFFF


29 -1)


11 -1) filter mask for the identifier: if ID_MASK bit = 0, CAN ID bit may be = 0 or 1 if ID_MASK bit = 1, CAN ID bit must be = ID bit

70



>



Parameter

MATCHED_ID

DATALENGTHCOUNT

DATA

MORE_DATA_AVAILABLE

RESULT

Data type

DWORD

BYTE


BOOL

BYTE


0

Value dec | hex

00

Description

FB is inactive

1

5

9

242

250

01

05

09

F2

FA function block execution completed without error

FB is being processed – still receiving

CAN is not active



Description number of the data object identifier

= Data Length Count number of the data bytes received received data, (1...8 bytes)

TRUE: further received data available in the FiFo

FALSE: no further data available in the FiFo feedback of the function block


7617

71



CAN_RX_RANGE





7592

>

Description

7594

CAN_RX_RANGE provides the following settings:

 select the message type (11 or 29 bits),

 define an identifier range.

>

CAN_RX filters for the set identifier. If several CAN messages with the same identifier are received in one cycle, only the last / latest message is available.


7595

Parameter

ENABLE

CHANNEL

ID_START

ID_STOP

Extended


Data type

BOOL

BYTE

DWORD

DWORD

BOOL := FALSE

Description





CAN interface (1...n) depending on the device start number of the data object identifier range: normal frame (2 11 ):

0...2 047 = 0x0000 0000...0x0000 07FF extended frame (2 29 ):

0...536 870 911 = 0x0000 0000...0x1FFF FFFF end number of the data object identifier range: normal frame (2 11 ):


0...536 870 911 = 0x0000 0000...0x1FFF FFFF


29 -1)


11 -1)

72



>



Parameter

ID

DATALENGTHCOUNT

DATA

RESULT

Data type

DWORD

BYTE


BYTE


Value dec | hex

Description

5

9

0

1

242

00

01

05

09

F2



– still receiving

CAN is not active


Description



2 048...536 870 911 = 0x0000 0800...0x1FFF FFFF



7598

73



CAN_RX_RANGE_FIFO

= CAN RX range with FiFo





7601

>

Description

CAN_RX_RANGE_FIFO basically works like CAN_RX_RANGE (

→ p. 72 ).

In addition, CAN_RX_RANGE_FIFO provides a FiFo for the received data. Thus several CAN messages can be received in one cycle.

No overwriting takes place when the FiFo is full. Inbound messages will be lost.

>

In this event:

► Use ENABLE to deactivate and reactivate the function.

>

The FiFo is deleted and can be newly filled.


Parameter

ENABLE

CHANNEL

ID_START

ID_STOP

Extended


Data type

BOOL

BYTE

DWORD

DWORD

BOOL := FALSE

Description





CAN interface (1...n) depending on the device start number of the data object identifier range: normal frame (2 11 ):


0...536 870 911 = 0x0000 0000...0x1FFF FFFF end number of the data object identifier range: normal frame (2 11 ):


0...536 870 911 = 0x0000 0000...0x1FFF FFFF


29 -1)


11 -1)

7603

7595

74



>



Parameter

ID

DATALENGTHCOUNT

DATA

MORE_DATA_AVAILABLE

RESULT

Data type

DWORD

BYTE


BOOL

BYTE


0

Value dec | hex

00

Description

FB is inactive

1

5

9

242

250

01

05

09

F2



– still receiving

CAN is not active



Description



2 048...536 870 911 = 0x0000 0800...0x1FFF FFFF

= Data Length Count number of the data bytes received received data, (1...8 bytes)




7604

75




Function elements: transmit RAW-CAN data

CAN_TX..................................................................................................................................................77

CAN_TX_ENH ........................................................................................................................................78

CAN_TX_ENH_CYCLIC .........................................................................................................................80

15055

76



CAN_TX





7522

>

Description

7523

CAN_TX sends a standard message per cycle.

The FB limits itself to a few functions and the required memory space is low.

> If an instance of this FB is called several times during a cycle, the data is also sent several times.

>

In case of the simple functions CAN_TX and CAN_RX, it is determined by means of the ID whether a standard or an extended frame is to be sent. With the enhanced versions this is set via the input

EXTENDED. Therefore, extended frames in the ID area 0...2047 cannot be sent via the easy functions.


7524

Parameter

ENABLE

CHANNEL

ID

Data type

BOOL

BYTE

DWORD


Description








2 048...536 870 911 = 0x0000 0800...0x1FFF FFFF data to be sent (1...8 bytes)

>

DATA


7527

Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

242

250

00

01

F2

FA




77



CAN_TX_ENH

= CAN TX enhanced





7558

>

Description

>

7559

Additional setting options are offered through CAN_TX_ENH (for: enhanced). Here, all CAN specific characteristics can be set individually, e.g.:



Is it an 11 or a 29 bit identifier?



The additional inputs can be preset so that CAN_TX (

→ p. 77 ) is not required.

>

If an instance of this FB is called several times during a cycle, the data is also sent several times.


7634

Parameter

ENABLE

CHANNEL

ID

Extended


DATALENGTHCODE

DATA

Data type

BOOL := FALSE

BYTE

DWORD

BOOL := FALSE

BYTE


Description


Edge: enter the new values

FALSE: unit is not executed reset internal remote values




0...536 870 911 = 0x0000 0000...0x1FFF FFFF


29 -1)


11 -1)

= Data Length Code number of the data bytes to be sent (0...8) data to be sent (1...8 bytes)

78



>



Parameter

RESULT

Data type

BYTE




0

Value dec | hex

00

Description

FB is inactive

1

242

250

01

F2




7527

79



CAN_TX_ENH_CYCLIC

= CAN TX enhanced cyclic





7568

>

Description

7569

CAN_TX_ENH_CYCLIC serves for cyclical transmitting of CAN messages.

Otherwise, the FB corresponds to CAN_TX_ENH (

→ p. 78 ).

► Set the period duration via the parameter PERIOD.

>

If a period is too short, this could lead to a high bus load which could affect the performance of the complete system.


7582

Parameter

ENABLE

CHANNEL

ID

Extended


DataLengthCode


DATA

PERIOD

Data type

BOOL

BYTE

DWORD

BOOL := FALSE

BYTE := 8


TIME

Description








0...536 870 911 = 0x0000 0000...0x1FFF FFFF


29 -1)


11 -1) length of the data to be sent (0...8 bytes) data to be sent (1...8 bytes) period duration

80



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

9

242

250

0

1

8

00

01

08

09

F2

FA

FB is inactive


– data is valid function block is active

CAN is not active



7510

81




Function elements: RAW-CAN remote

CAN_REMOTE_REQUEST ...................................................................................................................83

CAN_REMOTE_RESPONSE.................................................................................................................84

15057

82



CAN_REMOTE_REQUEST





7625

>

Description

>

In order to request a remote message, an according requirement is dispatched via

CAN_REMOTE_REQUEST and the response of the other device is sent back as result.


7627

7628

Parameter

EXECUTE

CHANNEL

ID

Data type

BOOL := FALSE

BYTE

DWORD

Description






0...536 870 911 = 0x0000 0000...0x1FFF FFFF


29 -1)


11 -1)

>

Extended



BOOL := FALSE

Parameter

DATALENGTHCOUNT

DATA

RESULT

Data type

BYTE


BYTE


Value dec | hex

Description

0

1

5

9

242

00

01

05

09

F2


FB is being processed – still receiving

CAN is not active


Description



7629

83



CAN_REMOTE_RESPONSE





7631

>

Description

7633

CAN_REMOTE_RESPONSE provides data to the CAN controller in the device which is automatically sent upon the request of a remote message.

This FB strongly depends on the device type. Only a limited number of remote messages can be set up:

BasicController: CR040n, CR041n, CR043n

BasicDisplay: CR045n max. 40 remote messages

>

PDM360 NG: CR108n, CR120n max. 100 remote messages


7634

Parameter

ENABLE

CHANNEL

ID

Extended


DATALENGTHCODE

DATA

Data type

BOOL := FALSE

BYTE

DWORD

BOOL := FALSE

BYTE


Description


Edge: enter the new values

FALSE: unit is not executed reset internal remote values




0...536 870 911 = 0x0000 0000...0x1FFF FFFF


29 -1)


11 -1)

= Data Length Code number of the data bytes to be sent (0...8) data to be sent (1...8 bytes)

84



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

8

10

242

0

6

7

08

0A

F2

00

06

07

FB is inactive


– remote for ID not active

FB is being processed – remote for ID active function block is active no further remote entrys available


7636

85




5.2.3

Function elements: CANopen

Function elements: CANopen status ......................................................................................................86

Function elements: CANopen network management .............................................................................95

Function elements: CANopen object directory .......................................................................................99

Function elements: CANopen SDOs ....................................................................................................104

Function elements: CANopen SYNC ...................................................................................................117

Function elements: CANopen guarding ...............................................................................................121

Function elements: CANopen emergency ............................................................................................125

15059

For CANopen, ifm electronic provides a number of function elements which will be explained in the following.

Function elements: CANopen status

CANOPEN_ENABLE ..............................................................................................................................87

CANOPEN_GETBUFFERFLAGS ..........................................................................................................89

CANOPEN_GETSTATE .........................................................................................................................91

CANOPEN_SETSTATE .........................................................................................................................93

15061

86



CANOPEN_ENABLE


Unit is contained in the library ifm_CANopen_NT_Vxxyyzz.LIB



7785

>

Description

7787

CANOPEN_ENABLE allows to switch the CANopen master on or off.

► In the application program always call an own instance of the FB CANOPEN_ENABLE (

→ p. 87 )

for every CAN interface!

To avoid guarding or heartbeat errors the nodes must be "shut down" via an appropriate sequence first.

If the master is restarted after a stop, all other connected nodes also have to be re-initialised.

>

Without CANOPEN_ENABLE, the CANopen master is started automatically, as far as this has been selected in the configuration.

The configured baud rate is only adopted if

CAN_ENABLE

(

→ p. 61 ) has not been activated before.


7788

Parameter

ENABLE

CHANNEL

Baud rate


Data type

BOOL := TRUE

BYTE

WORD := 0

Description

TRUE:

FALSE:

• Enable CANopen for the selected channel

• Start CANopen manager or CANopen device

according to the configuration settings

• Disable CANopen for the selected channel

• Terminate CANopen manager or CANopen device


Baud rate [kbits/s] permissible values = 20, 50, 100, 125, 250, 500, 800, 1 000

0 = use setting from the PLC configuration

87



>



Parameters

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

14

15

238

239

242

00

01

0E

0F

EE

EF

F2


FB is active

CANopen manager configures devices and sends SDOs

FB is active

CANopen manager is started

Error: CANopen configuration is too large and cannot be started

Error: CANopen manager could not be started


7789

88



CANOPEN_GETBUFFERFLAGS

= Get buffer flags





7890

>

Description

CANOPEN_GETBUFFERFLAGS supplies information on the buffer flags.

The flags can be reset via the optional inputs.

>

The function block returns the state of the overflow flags.


Parameter

EXECUTE

CHANNEL

ResetRXFlags


ResetTXFlags


Data type

BOOL := FALSE

BYTE

BOOL := FALSE

BOOL := FALSE

Description




TRUE: Provide fag status at the output and then reset


TRUE: Provide flag status at the output and then reset


7892

7893

89



>



Parameter

RXOVFL

RXWARN

TXOVFL

TXWARN

RESULT

Data type

BOOL

BOOL

BOOL

BOOL

BYTE


Value dec | hex

Description

0

1

8

242

00

01

08

F2

FB is inactive function block execution completed without error function block not yet executed


Description condition of the RX overflow flag

TRUE: overflow in the receive buffer

FALSE: no overflow in receive buffer condition of the RX overflow warning flag

TRUE: level in the receive buffer is critical

FALSE: level in the input buffer is uncritical condition of the TX overflow flag

TRUE: overflow in the transmit buffer

FALSE: no overflow in transmit buffer

Condition of the TX overflow warning flag

TRUE: Level in the transmit buffer is critical

FALSE: Level in the transmit buffer is uncritical feedback of the function block


7894

90



CANOPEN_GETSTATE

= Get state





7865

>

Description

>

Via CANOPEN_GETSTATE, parameters of the master, a slave device or a specific node in the network can be set.


Parameter

EXECUTE

CHANNEL

NODE

Data type

BOOL := FALSE

BYTE

BYTE

7867

Description




Node ID = ID of the node (0...127)

Device as CANopen master:

Value = 0:

Only the status information of the device itself is returned at the outputs. The outputs with information on the nodes are invalid.

Value not 0:

Node ID of a node in the network. For this one as well as for the device the states are returned at the outputs.

Device as CANopen slave:

Value = 0 (preset):

The status information of the slave is returned at the outputs.

Value not 0: no action

7868

91




>


Parameter

MASTERSTATE

PLCNODEID

PLCBAUDRATE

PLCVERSION

CANSTATE

NODESTATE

LASTNODESTATE

RESULT

Data type

BYTE

BYTE

DWORD

DWORD

BYTE

BYTE

BYTE

BYTE

Description

Master state = internal state of the master:

0 = 0x00 = master starts up

4 = 0x04 = node configuration running

5 = 0x05 = normal operating state of the master

255 = 0xFF = PLC running as slave

PLC node ID = node ID of the PLC the program is running on

Value = 0...127 = 0x00...0x7F

Baudrate of the PLC

PLC version

Status of the CANopen network

Device operated as master:

Node ID = 0 (device as such):

0 = 0x00 = OK

128 = 0x80 = BUSOFF

Node ID ≠ 0 (node):

0 = 0x00 = OK

1 = 0x01 = guard or heartbeat error on node

128 = 0x80 = BUSOFF

Device operated as slave:

0 = 0x00 = OK

1 = 0x01 = guard or heartbeat error

128 = 0x80 = BUSOFF

Node state = internal node state of a slave seen from the master's perspective. The input NODEID identifies the node.

-1 = 0xFF = reset after ResetNode

1 = 0x01 = waiting for BOOTUP

2 = 0x02 = after receipt of the BOOTUP message

3 = 0x03 = not yet configured: STOPPED

4 = 0x04 = after configuration with SDOs: PRE-OPERATIONAL

5 = 0x05 = after starting the node: OPERATIONAL

97 = 0x61 = optional node

98 = 0x62 = other device type configured than in 0x1000

99 = 0x63 = node guarding

Last Node State

Node state according to CANopen (with these values the status is also coded in the corresponding messages with regard to the node).

0

4

5

127

0x00 BOOTUP

0x04 STOPPED

0x05 OPERATIONAL

0x7F PRE-OPERATIONAL feedback of the function block



0

Value dec | hex

00

Description

1

8

01

08

FB is inactive

FB execution completed without error – data is valid

FB is active – not yet processed

242 F2 Error: setting is not possible

92

7869



CANOPEN_SETSTATE

= Set state





7858

>

Description

7860

>

Via CANOPEN_SETSTATE, parameters of the master, a slave device or a node in the network can be set.

The treatment of the NMT state of master, node or device is carried out in the CAN stack or via the commands of the FB


(

→ p. 97 ). At the same time admissibility checks are

carried out. For reasons of consistency no inputs are provided for this purpose.


7861

Parameter

EXECUTE

CHANNEL

NODE

GlobalStart


CfgTimeout


Data type

BOOL := FALSE

BYTE

BYTE

BOOL := TRUE

TIME := T#0ms

Description




Node ID = ID of the node (0...127)

Device as CANopen master:

Value = 0:

The changes only refer to the device itself.

Value not 0:

Node ID of a node in the network the parameters of which are to be changed. The established settings are only adopted for this node (not for the device).

Device as CANopen slave:

In slave mode, the node ID of the slave can be set via this input.

Value = 0: no action

Value not 0:

The function block adopts this value as the new node ID of the device.

Requirement: FB must be called immediately after starting the IEC program. This setting overwrites the setting of the configuration.

TRUE: Start all participants simultaneously

FALSE: Start all participants one after the other set configuration timeout for a node:

Value = 0: no action – retain configuration data

Value not 0: overwrite data from the configuration with the new value

93



Parameter

InitNoSdos


Data type

BOOL := FALSE


Description

To the node indicated in NODE, during initialisation,...

TRUE: do not send configuration data

FALSE: send configured SDOs

>


Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

8

242

00

01

08

F2

FB is inactive




7862

94




Function elements: CANopen network management

CANOPEN_GETNMTSTATESLAVE .....................................................................................................96

CANOPEN_NMTSERVICES ..................................................................................................................97

15063

95



CANOPEN_GETNMTSTATESLAVE

= Get network management state slave





7851

>

Description

>

► Only use the FB if the device is operated as CANopen slave!

With CANOPEN_GETNMTSTATESLAVE, only the operating state according to CANopen and an error message are reported to the application if an invalid state transition has been requested.


7853

7854

Parameter

EXECUTE

Data type

BOOL := FALSE

BYTE

Description




>

CHANNEL


7855

Parameter

NMTSTATE

RESULT

Data type

BYTE

BYTE


Value dec | hex

Description

0

1

8

242

00

01

08

F2




Description

Network operating status of the node

0 = INIT

1 = OPERATIONAL

2 = PRE-OPERATIONAL

3 = STOPPED feedback of the function block


96




= Network management services





7843

>

Description

>

Depending on its NMT command entries, CANOPEN_NMTSERVICES either triggers an NMT command or the initialisation of a node.

NMT = N etworkM anagemen T

The function block updates the internal node status. If a state transition to CANopen ( → system manual "Know-How ecomat mobile " > NMT state ) should not be permitted, the command is not executed.

A CANopen device can automatically change its CANopen state by means of the FB: preoperational  operational


7844

7847

Parameter

EXECUTE

CHANNEL

NODE

NMTSERVICE

Timeout


Data type

BOOL := FALSE

BYTE

BYTE

BYTE

TIME := T#0ms

Description




CANopen ID of the node permissible = 0...127 = 0x00...0x7F

NODE = 0: command applies to all nodes in the network

NODE = Node ID of the device: command applies to the device as such network command

0 = init node (except master)

1 = enter PRE-OPERATIONAL

2 = start node

3 = reset node

4 = reset communication

5 = stop node waiting time of the FB for the initialisation when the time has elapsed, the FB stops waiting.

0 = use value from the configuration

97



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

35

36

37

43

0

1

8

241

242

23

24

25

2B

00

01

08

F1

F2

FB is inactive function block execution completed without error function block is active at least 1 SDO of the configuration was not successful node was already initialised when initialisation was requested the node was not in the PRE-OPERATIONAL mode master / slave is not initialised

Error: CANopen state transition is not permitted


7848

98




Function elements: CANopen object directory

CANOPEN_GETODCHANGEDFLAG .................................................................................................100

CANOPEN_READOBJECTDICT .........................................................................................................101

CANOPEN_WRITEOBJECTDICT .......................................................................................................102

15065

99



CANOPEN_GETODCHANGEDFLAG

= Get object directory changed flag





7927

>

Description

7928

>

CANOPEN_GETODCHANGEDFLAG reports any change of value for a particular object directory entry.


7930

Parameter

EXECUTE

>

CHANNEL

IDX

SUBIDX


Data type

BOOL := FALSE

BYTE

WORD

BYTE

Description



CAN interface (1...n) depending on the device index in object directory sub-index referred to the index in the object directory

7931

Parameter

DATA

RESULT

Data type

DWORD

BYTE

Description parameter value feedback of the function block



Value dec | hex

Description

0

1

8

242

00

01

08

F2




100



CANOPEN_READOBJECTDICT

= Read object directory





7933

>

Description

7935

>

CANOPEN_READOBJECTDICT reads up to 4 bytes of configuration data from the object directory of the device for use in the application program.


7936

Parameter

EXECUTE

>

CHANNEL

IDX

SUBIDX


Data type

BOOL := FALSE

BYTE

WORD

BYTE

Description



CAN interface (1...n) depending on the device index in object directory sub-index referred to the index in the object directory

7937

Parameter

DATA

RESULT

Data type

DWORD

BYTE

Description parameter value feedback of the function block



Value dec | hex

Description

0

1

8

40

242

00

01

08

28

F2

FB is inactive function block execution completed without error function block not yet executed object directory entry is invalid


101



CANOPEN_WRITEOBJECTDICT

= Write object directory





7940

>

Description

CANOPEN_WRITEOBJECTDICT writes configuration data to the object directory of the controller.

7942

>

NOTICE

This could lead to falsification of important system settings, e.g.:

- guarding times

- heartbeat times

► Carefully verify input parameters!


7943

Parameter

EXECUTE

CHANNEL

IDX

SUBIDX

DATA

Data type

BOOL := FALSE

BYTE

WORD

BYTE

DWORD

Description



CAN interface (1...n) depending on the device index in object directory sub-index referred to the index in the object directory parameter value

102



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

8

40

242

00

01

08

28

F2

FB is inactive function block execution completed without error function block not yet executed object directory entry is invalid


7945

103




Function elements: CANopen SDOs

CANOPEN_SDOREAD ........................................................................................................................105

CANOPEN_SDOREADBLOCK ............................................................................................................107

CANOPEN_SDOREADMULTI .............................................................................................................109

CANOPEN_SDOWRITE ......................................................................................................................111

CANOPEN_SDOWRITEBLOCK ..........................................................................................................113

CANOPEN_SDOWRITEMULTI ...........................................................................................................115

2071

Here you will find ifm function elements for CANopen handling of Service Data Objects (SDOs).

104



CANOPEN_SDOREAD

= SDO read





7791

>

Description

CANOPEN_SDOREAD is an easy function block for editing "Expedited SDOs", i.e. SDOs with max.

4 bytes of user data. This type usually represents the bigger part of the SDO communication.

7793

>

Expedited SDO = Expedited Service Data Object

A considerable amount of memory space can be saved due to the limitation of the data volume to max. 4 bytes of user data, as this FB only needs to reserve 4 bytes as buffer storage and does not create a large data array itself.


7794

Parameter

EXECUTE

CHANNEL

NODE

IDX

SUBIDX

Timeout


Data type

BOOL := FALSE

BYTE

BYTE

WORD

BYTE

TIME := T#10ms

Description




ID of the node permissible values = 1...127 = 0x01...0x7F index in object directory sub-index referred to the index in the object directory waiting time of the FB for the response when the time has elapsed, the FB stops waiting. value = 0: use value from the configuration

105



>



Parameter

LEN

DATA

RESULT

Data type

BYTE

DWORD

BYTE

Description number of the bytes received (1...4) the received data value (up to 4 bytes) feedback of the function block



Value dec | hex

Description

0

1

5

32

33

242

255

21

F2

FF

00

01

05

20

FB is inactive


– data is valid

FB is active – no data received yet

SDO transmission aborted by client or server

(SDO abort code 0x80)

TIMEOUT elapsed

Error: setting is not possible buffer overflow – too many data bytes were received

7795

106



CANOPEN_SDOREADBLOCK

= SDO Read Block





14942

>

Description

14943

CANOPEN_SDOREADBLOCK reads the indicated entry in the object directory of a node in the network via SDO block transfer.

>

If the node doesn't support block transfer, the FB automatically changes to "segmented transfer".

You can also directly change to "segmented transfer" via the input.

>

The COB ID for the SDO is calculated from the transmitted node ID.

The length of multiframe SDOs is generally not limited.

For systems without a file system (e.g. BasicController CR04nn) the following applies:

► transmit an address to the FB which is accessed by the pointer for writing. The memory area determined by the start address DATA and the amount of data MAX_LEN must be available!

> If the amount of data is greater than indicated, the transfer is stopped and signalled via RESULT.

For systems with a file system (e.g. PDM360NG CR108n) the following applies:

► transmit the path and name of a file to the FB, in which the data is to be saved in binary format.

>

The output RESULT provides information on the status of the SDO transmission.

107



>


Parameter

EXECUTE

CHANNEL

NODE

IDX

SUBIDX

DATA

FILE

MAX_LEN

SegmentedTransfer


Timeout


>


Data type

BOOL := FALSE

BYTE

BYTE

WORD

BYTE

DWORD

STRING(80)

DWORD

BOOL := FALSE

TIME := T#10ms


14945

Description




(Node ID) ID of the node allowed = 1...127 = 0x01...0x7F

The COB ID of the SDO is calculated from the node ID + 0x600 index in object directory sub-index referred to the index in the object directory

Address of the data zone for storage of the received data

Input is without function for devices with file system (Linux).

Path and file name for storage of the received data in binary format

Input without function for device without file system

(BasicSystem).

Maximum permitted number of bytes which may be received

TRUE: Segmented SDO transfer

FALSE: SDO block transfer waiting time of the FB for the response when the time has elapsed, the FB stops waiting. value = 0: use value from the configuration

Parameter

LEN

RESULT

Data type

DWORD

BYTE

Description number of received data bytes feedback of the function block



Value dec | hex

Description

33

64

65

66

242

0

1

5

16

17

32

21

40

41

42

F2

00

01

05

10

11

20

FB is inactive


FB is active

– no data received yet

Transmission is active as a segmented download

Transmission is active as a block download



TIMEOUT elapsed

Error: Write pointer outside admissible data range

Error: File could not be opened

Error when writing to file


108

14951



CANOPEN_SDOREADMULTI

= SDO read multi





7806

>

Description

7808

>

CANOPEN_SDOREADMULTI reads the indicated entry in the object directory of a node in the network. The COB ID for the SDO is calculated from the transmitted node ID according to CANopen convention.


7809

Parameter

EXECUTE

CHANNEL

NODE

IDX

SUBIDX

Timeout


Data type

BOOL := FALSE

BYTE

BYTE

WORD

BYTE

TIME := T#10ms

Description





The COB ID of the SDO is calculated from the node ID + 0x600 index in object directory sub-index referred to the index in the object directory waiting time of the FB for the response when the time has elapsed, the FB stops waiting. value = 0: use value from the configuration

109



>



Parameter

LEN

DATA

RESULT

Data type

DWORD

Description number of the bytes received permissible values = 1...2 048 = 0x0000 0001...0x0000 0800

ARRAY [0..SDOMAXDATA] OF

BYTE buffer memory for user data of the SDO data transmission

BYTE feedback of the function block



Value dec | hex

Description

0

1

5

32

33

242

255

21

F2

FF

00

01

05

20

FB is inactive





TIMEOUT elapsed


Error: not enough memory available for the consuming multiframe

7810

110



CANOPEN_SDOWRITE

= SDO write





7825

>

Description

7826

CANOPEN_SDOWRITE is an easy function block for editing "Expedited SDOs", i.e. SDOs with max.

4 bytes user data. This type usually represents the bigger part of the SDO communication.

>

Expedited SDO = expedited service data object

A considerable amount of memory space can be saved due to the limitation of the data volume to max. 4 bytes of user data because this FB only needs to reserve 4 bytes as buffer storage and does not create a large data array itself.


7828

Parameter

EXECUTE

CHANNEL

NODE

IDX

SUBIDX

LEN

DATA

Timeout


Data type

BOOL := FALSE

BYTE

BYTE

WORD

BYTE

BYTE


TIME := T#10ms

Description




ID of the node permissible values = 1...127 = 0x01...0x7F index in object directory sub-index referred to the index in the object directory number of the data bytes to be transmitted permissible values = 1...4 = 0x01...0x04 data area (1...4 bytes) waiting time of the FB for the response when the time has elapsed, the FB stops waiting. value = 0: use value from the configuration

111



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

8

32

33

242

00

01

08

20

21

F2

FB is inactive





TIMEOUT elapsed


7829

112



CANOPEN_SDOWRITEBLOCK

= SDO Write Block





14961

>

Description

14963

CANOPEN _SDOWRITEBLOCK writes in the indicated entry in the object directory of a node in the network via SDO block transfer.

You can change to segmented transfer via the FB input if required.

> The COB ID for the SDO is calculated from the transmitted node ID.

> The output RESULT provides information on the status of the SDO transmission.

The length of multiframe SDOs is generally not limited.

For systems without a file system (e.g. BasicController CR04nn) the following applies:

► transmit an address to the FB which is accessed by the pointer for reading.

For systems with a file system (e.g. PDM360NG CR108n) the following applies:

► Transmit the path and name of a file to the FB, from which the data is to be read in binary format.

113



>


Parameter

EXECUTE

CHANNEL

NODE

IDX

SUBIDX

LEN

DATA

FILE

SegmentedTransfer


Timeout


>


Data type

BOOL := FALSE

BYTE

BYTE

WORD

BYTE

DWORD

DWORD

STRING(80)

BOOL := FALSE

TIME := T#10ms


14964

Description





The COB ID of the SDO is calculated from the node ID + 0x600 index in object directory sub-index referred to the index in the object directory number of data bytes to be transmitted in DATA allowed = 1...2 048 = 0x0000 0001...0x0000 0800

Address of the data zone for reading of the data to be transmitted

Input is without function for devices with file system (Linux).

Path and file name for reading of the data to be transmitted in binary format

Input without function for device without file system

(BasicSystem).

TRUE: Segmented SDO transfer

FALSE: SDO block transfer waiting time of the FB for the response when the time has elapsed, the FB stops waiting. value = 0: use value from the configuration

Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

8

16

17

32

33

65

242

21

41

F2

00

01

08

10

11

20

FB is inactive


FB is active

– not yet processed

Transmission is active as a segmented download

Transmission is active as a block download



TIMEOUT elapsed

Error: File could not be opened


114

14968



CANOPEN_SDOWRITEMULTI

= SDO write multi





7832

>

Description

>

CANOPEN_SDOWRITEMULTI writes the indicated entry in the object directory of a node in the network. The COB ID for the SDO is calculated from the transmitted node ID according to CANopen convention.

7834


7835

Parameter

EXECUTE

CHANNEL

NODE

IDX

SUBIDX

LEN

DATA

Timeout


Data type

BOOL := FALSE

BYTE

BYTE

WORD

BYTE

DWORD

Description




ID of the node permissible values = 1...127 = 0x01...0x7F index in object directory sub-index referred to the index in the object directory number of the data bytes to be transmitted permissible values = 1...2 048 = 0x0000 0001...0x0000 0800

ARRAY [0..SDOMAXDATA] OF

BYTE buffer memory for user data of the SDO data transmission

TIME := T#10ms waiting time of the FB for the response when the time has elapsed, the FB stops waiting. value = 0: use value from the configuration

115



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

8

32

33

242

00

01

08

20

21

F2

FB is inactive





TIMEOUT elapsed


7836

116




Function elements: CANopen SYNC

CANOPEN_GETSYNCSTATE .............................................................................................................118

CANOPEN_SETSYNCSTATE .............................................................................................................120

15069

117



CANOPEN_GETSYNCSTATE

= Get SYNC state





7871

>

Description

7872

CANOPEN_GETSYNCSTATE reads...

• the setting of the SYNC functionality (active / not active),

• the error state of the SYNC functionality (SyncError).

If the PLC CAN runs as CANopen slave, it is signalled via this FB whether SYNC signals are absent or appear regularly.

>

Synchronous PDOS etc. are handled in the CAN stack. CANOPEN_GETSYNCSTATE, however, provides the error state so that the application program can react accordingly.


7874

Parameter

EXECUTE

CHANNEL

Data type

BOOL := FALSE

BYTE

Description




118




>


7875

Parameter

SYNC

SYNCERROR

RESULT

Data type

BOOL

BYTE

BYTE


Value dec | hex

Description

0

1

8

242

00

01

08

F2

FB is inactive function block execution completed without error function block not yet executed


Description status of the SYNC functionality

TRUE: SYNC is activated:

In the master mode SYNC telegrams are generated according to the settings in the configuration, and synchronous PDOs are transmitted and received.

In the slave mode SYNC telegrams are received and accordingly processed.

FALSE: SYNC is not active

(sync error) SYNC error message

0 = no error

>0 = SYNC error (slave mode) feedback of the function block


119



CANOPEN_SETSYNCSTATE

= Set SYNC state





7883

>

Description

7884

>

With CANOPEN_SETSYNCSTATE, the SYNC functionality is switched on and off.


Parameter

EXECUTE

CHANNEL

SYNC

Data type

BOOL := FALSE

BYTE

BOOL

7886

Description



CAN interface (1...n) depending on the device status of the SYNC functionality

TRUE: SYNC is activated:

In the master mode SYNC telegrams are generated according to the settings in the configuration, and synchronous PDOs are transmitted and received.

In the slave mode SYNC telegrams are received and accordingly processed.

FALSE: SYNC is not active

>


7887

Parameter

RESULT

Data type

BYTE




0

Value dec | hex

00

Description

FB is inactive

1

8

38

242

01

08

26

F2 function block execution completed without error function block not yet executed

SYNC could not be activated


120




Function elements: CANopen guarding

CANOPEN_GETGUARDHBERRLIST .................................................................................................122

CANOPEN_GETGUARDHBSTATSLV ................................................................................................123

15071

121



CANOPEN_GETGUARDHBERRLIST

= Get guard and heartbeat error list





7896

>

Description

7898

>

CANOPEN_GETGUARDHBERRLIST lists all nodes in an array for which the master has detected an error:

• guarding error

• heartbeat error


7899

Parameter

EXECUTE

CHANNEL

ResetList


Data type

BOOL := FALSE

BYTE

BOOL := FALSE

Description




Reset error list

TRUE: Provide the error list as well as number of faulty nodes at the output and then reset.


>


7900

Parameter

N_NODES

NODEID

RESULT

Data type

WORD

ARRAY

[0..MAXGUARDERROR] OF

BYTE

BYTE


Value dec | hex

Description

0

1

8

242

00

01

08

F2




Description

Number of nodes with heartbeat or guarding error

0 = none of the nodes has a guarding or heartbeat error

List of node IDs with heartbeat or guarding error.

The most recent entry is in index 0.

MAXGUARDERROR depends on device

→ chapter Limitations for CANopen in this device

(→ p. 33 )

feedback of the function block


122



CANOPEN_GETGUARDHBSTATSLV

= Get guard and heartbeat state slave





7902

>

Description

CANOPEN_GETGUARDANDHBSTATESLAVE reports the following states to the controller in slave operation:

- monitoring of node guarding

- monitoring of heartbeat

>

The controller can either be the heartbeat producer or the heartbeat consumer.

7904


7905

Parameter

EXECUTE

CHANNEL

Reset


Data type

BOOL := FALSE

BYTE

BOOL := FALSE

Description




TRUE: Provide the current states at the outputs and then reset to "No error"


123




>


Parameter

GUARDSTATE

PROD_HBSTATE

CONS_HBSTATE

CONS_HBCOBID

RESULT

Data type

BYTE

BYTE

BYTE

WORD

BYTE


0

Value dec | hex

00

Description

FB is inactive

1

8

242

01

08

F2 function block execution completed without error

FB is active

– not yet processed


Description

Status of node guarding:

0 = 0x00 = no error (or: not active)

1 = 0x01 = timeout (configuration)

127 = 0x7F = no guarding message received controller as heartbeat producer:

0 = 0x00 = inactive

1 = 0x01 = active controller as heartbeat consumer:

0 = 0x00 = no fault

1 = 0x01 = timeout (configuration)

127 = 0x7F = no heartbeat message received yet

COB-ID of the heartbeat message the consumer heartbeat of the controller is reacting to (configuration) feedback of the function block


7906

124




Function elements: CANopen emergency

CANOPEN_GETEMCYMESSAGES ....................................................................................................126

CANOPEN_GETERRORREGISTER ...................................................................................................128

CANOPEN_SENDEMCYMESSAGE ...................................................................................................130

15073

125



CANOPEN_GETEMCYMESSAGES

= Get emergency messages





7921

>

Description

7923

>

CANOPEN_GETEMCYMESSAGES returns all emergency messages that have been received by the controller from other nodes in the network since the last deletion of messages.

The list can be reset by setting the according input. A maximum of MAXEMCYMSGS messages is stored. Each message contains information from which the node it was sent. The most recent message is in index 0.


7924

Parameter

EXECUTE

CHANNEL

RstList


Data type

BOOL := FALSE

BYTE

BOOL := FALSE

Description




TRUE: Provide list with accumulated CAN messages at the output and then delete


126



>



Parameter

N_MSGS

EMCY

RESULT

Data type

DWORD

ARRAY [0..MAXEMCYMSGS]

OF T_EMCY

BYTE


Value dec | hex

Description

0

1

8

242

00

01

08

F2




Description

Number of accumulated messages

Emergency messages

The most recent entry is in index 0.

Structure of T_EMCY:

.NODEID

.EEC

.ER

.MSEF

ID of the node from which the message came

Emergency Error Code

Error register

Manufacturer Specific Error Code

MAXEMCYMSG = 10 feedback of the function block


7925

127



CANOPEN_GETERRORREGISTER

= Get error register





7915

>

>

Description

7917

CANOPEN_GETERRORREGISTER reads the error registers 0x1001 and 0x1003 from the controller.


7918

Parameter

EXECUTE

CHANNEL

Reset_1001


Reset_1003


Data type

BOOL := FALSE

BYTE

BOOL := FALSE

BOOL := FALSE

Description




TRUE: Reset error register 0x1001


TRUE: Reset error register 0x1003

Set number of entries to 0


The inputs remain unchanged.

128



>



Parameter

ER

ERROR_FIELD

RESULT

Data type

BYTE

ARRAY [0..MAXERR] OF

DWORD

BYTE


Value dec | hex

Description

0

1

8

242

00

01

08

F2




Description

Content of the error register 0x1001

Content of the error register 0x1003

Index 0 = number of the stored errors

Index 1...MAXERR = stored errors

The most recent error is in index 1

Preset: MAXERR = 5 feedback of the function block


7919

129



CANOPEN_SENDEMCYMESSAGE

= Send emergency message





7908

>

Description

7910

>

CANOPEN_SENDEMCYMESSAGE sends an EMCY message. The message is assembled from the according parameters and entered in register 0x1003. The COB ID for the emergency message is determined from the configuration data.


7911

Parameter

EXECUTE

CHANNEL

ERRORACTIVE

EEC

ER


MSEF

Data type

BOOL := FALSE

BYTE

BOOL

WORD

BYTE := 0


Description




FALSE  TRUE (edge): sends the next error code

TRUE  FALSE (edge):

If the error is no longer given, a message that there is no error is sent after a delay of 1 s.

EEC = Emergency Error Code

0 = use value from error register 0x1001

Write1003


SendSysStatus


BOOL := FALSE

BOOL := FALSE

MSEF = Manufacturer Specific Error Code =

Additional error code which is defined by the manufacturer.

Value comes from the application.

TRUE: Enter this EMCY message in object 0x1003


Send system status

TRUE: The system status is checked and in case of an error state this is transmitted to the network.


130



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

8

39

242

00

01

08

27

F2


FB is active – not yet processed no object 1001

16

in the configuration


7912

131




5.2.4

Function elements: SAE J1939

Function elements: SAE J1939 status .................................................................................................132

Function elements: SAE J1939 request ...............................................................................................140

Function elements: receive SAE J1939 ...............................................................................................143

Function elements: transmit SAE J1939 ..............................................................................................148

Function elements: SAE J1939 diagnosis ............................................................................................156

2273

For SAE J1939, ifm electronic provides a number of function elements which will be explained in the following.

Function elements: SAE J1939 status

J1939_ENABLE ....................................................................................................................................133

J1939_GETDABYNAME ......................................................................................................................135

J1939_NAME .......................................................................................................................................137

J1939_STATUS ....................................................................................................................................139

15077

132



J1939_ENABLE


Unit is contained in the library ifm_J1939_NT_Vxxyyzz.LIB



7641

>

Description

For initialisation of the J1939 stack, J1939_ENABLE is set to TRUE=1.

> This FB also causes booting of the soft I/Os of the CFG file.

> A different baud rate is only adopted if CAN_ENABLE has not been activated before.

>

ACE = A ddress C laiming E nable:



If an ifm controller communicates with only one engine controller via J1939: set ACE = FALSE.



If however several engine controllers are working on the same bus: set ACE = TRUE.

In this case the engine controllers must support the address claiming!

Otherwise you will risk an overlapping of addresses with subsequent system failure.


Parameter

ENABLE

CHANNEL

Baud rate


PreferredAddress


Ace


Data type

BOOL := FALSE

BYTE

WORD := 250

BYTE = 252

BOOL := TRUE

Description

TRUE: Enable J1939 channel

Ace=TRUE: Address claiming effected

FALSE: Block J1939 channel


Baud rate [Kbits/s] permissible values: 20, 50, 100, 125, 250, 500, 800, 1 000 preferred source address

Address Claiming Enable

TRUE: Address claiming enabled

(control unit is self-configuring)

FALSE: No address claiming

7642

7643

133



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

8

9

242

00

01

08

09

F2


CAN is not active


8542

134



J1939_GETDABYNAME

= get destination arbitrary name





7664

>

Description

7665

Via J1939_GETDABYNAME, the target address of one or several participants can be determined by means of the name information.



If a specific value is set on the optional inputs:

 the result list will only show the participants with this specific value.



If no value or the default value is set on the optional inputs:

 this entry is not taken into account during filtration of the list.

135



>


Parameter

ENABLE

CHANNEL

IndustryGroup


VehicleSystemInstance


VehicleSystem

(optional use of the parameter) nFunction


FunctionInstance


ECUInstance


ManufacturerCode


IdentityNumber


>


Data type

BOOL

BYTE

BYTE = 0xFF

BYTE := 0xFF

BYTE := 0xFF

WORD := 0xFFFF

BYTE := 0xFF

BYTE := 0xFF

WORD := 0xFFFF

DWORD := 0xFFFF FFFF


7667

Description





CAN interface (1...n) depending on the device industry group = industry group of the device permissible values = 0...7

255 = 0xFF = filter for all instance of the vehicle system permissible values = 0...15 = 0x00...0x0F

255 = 0xFF = filter for all vehicle system permissible values = 0...127 = 0x00...0x7F

255 = 0xFF = filter for all function of the device permissible values = 0...255 = 0x0000...0x00FF

65 535 = 0xFFFF = filter for all instance of the function permissible values = 0...31 = 0x00...0x1F

255 = 0xFF = filter for all instance of the control device permissible values = 0...7

255 = 0xFF = filter for all manufacturer code (must be requested from SAE) permissible values = 0...2047 (2 11 -1) = 0x0000...0x07FF

65 535 = 0xFFFF = filter for all serial number of the device (should not be overwritten) permissible values = 0...2047 (2 11 -1) = 0x0000 0000...0x0000 07FF

4 294 967 295 = 0xFFFF FFFF = filter for all

Parameter

DA

NUMBER

RESULT

Data type


BYTE

BYTE

Description

List of found participants

255 = no participant found with this number

Number of found bus participants. feedback of the function block



Value dec | hex

Description

0

1

8

242

00

01

08

F2

FB is inactive

FB execution completed without error – data is valid function block is active


7668

136



J1939_NAME





7646

>

Description

7648

Via J1939_NAME, the device can be given a name for identification in the network.

By default the name of ifm is used.

The user has the following options to change the name of the device:

► use the information from the CFG file or

► overwrite the requested data via J1939_NAME.

> If no value or a default value is set at the optional inputs:

 the preset value is not overwritten.

The following list shows the composition of the 64 bit NAME information according to SAE J1939-81:

Parameter arbitrary address capable industry group vehicle system instance vehicle system reserved function function instance

ECU instance

Data type

1 bit

3 bits

4 bits

7 bits

1 bit

8 bits

5 bits

3 bits

Description any desired address available industry group of the device instance of the vehicle system vehicle system reserved function of the device instance of the function instance of the controller manufacturer code identify number

11 bits

21 bits manufacturer code (must be applied for at SAE) serial number of the device (should not be overwritten)

Table: Composition of the 64 bit NAME information according to SAE J1939-81

137



>


Parameter

ENABLE

CHANNEL

IndustryGroup


VehicleSystemInstance


VehicleSystem

(optional use of the parameter) nFunction


FunctionInstance


ECUInstance


ManufacturerCode


IdentityNumber


>


Data type

BOOL := FALSE

BYTE

BYTE = 0xFF

BYTE := 0xFF

BYTE := 0xFF

WORD := 0xFFFF

BYTE := 0xFF

BYTE := 0xFF

WORD := 0xFFFF

DWORD := 0xFFFF FFFF


7652

Description

TRUE: Any desired address available

FALSE: Fixed address

CAN interface (1...n) depending on the device industry group = industry group of the device permissible values = 0...7

255 = 0xFF = filter for all instance of the vehicle system permissible values = 0...15 = 0x00...0x0F

255 = 0xFF = filter for all vehicle system permissible values = 0...127 = 0x00...0x7F

255 = 0xFF = filter for all function of the device permissible values = 0...255 = 0x0000...0x00FF

65 535 = 0xFFFF = filter for all instance of the function permissible values = 0...31 = 0x00...0x1F

255 = 0xFF = filter for all instance of the control device permissible values = 0...7

255 = 0xFF = filter for all manufacturer code (must be requested from SAE) permissible values = 0...2047 (2 11 -1) = 0x0000...0x07FF

65 535 = 0xFFFF = filter for all serial number of the device (should not be overwritten) permissible values = 0...2047 (2 11 -1) = 0x0000 0000...0x0000 07FF

4 294 967 295 = 0xFFFF FFFF = filter for all

Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

8

242

00

01

08

F2



7661

138



J1939_STATUS





7670

>

Description

>

Via J1939_STATUS, relevant information can be read back to the J1939 stack.


Parameter

ENABLE

Data type

BOOL

BYTE

Description






>

CHANNEL


Parameter

SA

CYCLIC

TIMEOUT

Data type

BYTE

WORD

BYTE

7672

7673

Description claimed source address number of the cyclic messages source address of the node which did not provided data for the process image in due time

255 = 0xFF = all nodes sent the data in due time

Version of the ifm CAN stack library feedback of the function block


7674

VERSION

RESULT

DWORD

BYTE


Value dec | hex

Description

3

4

242

0

1

2

03

04

F2

00

01

02

FB is inactive

Protocol is active

Protocol is not active

Source address requested

Address lost


139




Function elements: SAE J1939 request

J1939_SPEC_REQ ..............................................................................................................................141

J1939_SPEC_REQ_MULTI .................................................................................................................142

15079

140



J1939_SPEC_REQ

= J1939 Specific Request





15023

>

Description

15026

J1939_SPECIFIC_REQUEST requests and receives a specific message from another controller.

>

If a multiframe message is requested:

• the FB provides the first 8 bytes of the data

• RESULT indicates an error


15028

Parameter

EXECUTE

CHANNEL

PGN

Data type

BOOL := FALSE

BYTE

DWORD

BYTE

Description




PGN = Parameter Group Number permissible = 0...262 143 = 0x00000000...0x0003FFFF

J1939 address of the requested device

>

DA


15029

Parameter

PRIO

LEN

DATA

RESULT

Data type

BYTE

WORD


BYTE

Description message priority (0…7) number of the bytes received (0...8) received data, (1...8 bytes) feedback of the function block



0

Value dec | hex

00

Description

1

5

01

05

FB is inactive



64

242

40

F2

Error: receive multiframe


141



J1939_SPEC_REQ_MULTI

= J1939 Specific Request Multiframe Message





15033

>

Description

15036

>

J1939_SPECIFIC_REQUEST requests and receives a specific multiframe message from another controller.


15037

Parameter

EXECUTE

CHANNEL

PGN

Data type

BOOL := FALSE

BYTE

DWORD

BYTE

Description





J1939 address of the requested device

>

DA


15038

Parameter

PRIO

LEN

DATA

RESULT

Data type

BYTE

WORD


BYTE

Description message priority (0…7) number of data bytes to be transmitted allowed = 1...1 785 = 0x0001...0x06F9

Received data (1...1785 bytes) feedback of the function block



Value dec | hex

Description

0

1

5

242

00

01

05

F2

FB is inactive


FB is active

– no data received yet


142




Function elements: receive SAE J1939

J1939_RX .............................................................................................................................................144

J1939_RX_FIFO ...................................................................................................................................145

J1939_RX_MULTI ................................................................................................................................147

15081

143



J1939_RX





7724

>

Description

>

7725

J1939_RX is the easiest method for receiving single frame messages. The message read last on the

CAN bus is returned.


7726

Parameter

ENABLE

CHANNEL

PGN

Data type

BOOL

BYTE

DWORD

Description







The PGN = 0 is not used.

>


7727

Parameter

SA

PRIO

LEN

DATA

RESULT

Data type

BYTE

BYTE

WORD


BYTE


Value dec | hex

Description

5

9

0

1

242

00

01

05

09

F2



CAN is not active


Description

Source address of the transmitter message priority (0…7) number of the bytes received (0...8) received data, (1...8 bytes) feedback of the function block


144



J1939_RX_FIFO

= J1939 RX with FIFO





7732

>

Description

7733

>

J1939_RX_FIFO enables receipt of all specified messages and their successive reading from a FIFO.


7734

Parameter

ENABLE

CHANNEL

PGN

Data type

BOOL

BYTE

DWORD

Description








145



>



Parameter

SA

PRIO

LEN

DATA

MORE_DATA_AVAILABLE

RESULT

Data type

BYTE

BYTE

BYTE


BOOL

BYTE


Value dec | hex

Description

0

1

5

242

250

00

01

05

F2

FA

FB is inactive


– data is valid




Description

Source address of the transmitter message priority (0…7) number of the bytes received (0...8) received data, (1...8 bytes)




7735

146



J1939_RX_MULTI

= J1939 RX multiframe message





7736

>

Description

>

J1939_RX_MULTI enables receipt of multi-frame messages.


Parameter

EXECUTE

CHANNEL

PGN


>


Data type

BOOL := FALSE

BYTE

DWORD

Description





7741

7743

7744

Parameter

SA

PRIO

LEN

DATA

RESULT

Data type

BYTE

BYTE

WORD


BYTE


Value dec | hex

Description

0

1

5

242

00

01

05

F2

FB is inactive


– data is valid



Description

Source address of the transmitter message priority (0…7) number of the bytes received permissible values = 0...1 785 = 0x0000 0000...0x0000 06F9 data to be sent (1...1785 bytes) feedback of the function block


147




Function elements: transmit SAE J1939

J1939_TX .............................................................................................................................................149

J1939_TX_ENH ....................................................................................................................................150

J1939_TX_ENH_CYCLIC ....................................................................................................................152

J1939_TX_ENH_MULTI .......................................................................................................................154

15083

148



J1939_TX





7688

>

Description

>

J1939_TX is the easiest method for transmitting single frame messages.


Parameter

ENABLE

CHANNEL

DA

PGN

>

DATA


Data type

BOOL

BYTE

BYTE := 249

DWORD


Description






DA = Destination Address of the ECU

PGN > 61139: parameter DA is ignored

PGN = Parameter Group Number permissible = 0...262 143 = 0x00000000...0x0003FFFF data to be sent (1...8 bytes)

Parameter

RESULT

Data type

BYTE




0

Value dec | hex

00

Description

FB is inactive

1

242

250

01

F2




7689

7690

7693

149



J1939_TX_ENH

= J1939 TX enhanced





7696

>

Description

>

7697

Additional setting options are provided by J1939_TX_ENH (for: enhanced) for single frame messages:

 transmitting priority

 data length

Multi frame messages

 J1939_TX_ENH_MULTI (

→ p. 154 ).


7702

Parameter

ENABLE

CHANNEL

DA

Prio


PGN

Len


DATA

Data type

BOOL

BYTE

BYTE := 249

BYTE := 3

DWORD

BYTE := 8


Description







PGN > 61139: parameter DA is ignored message priority permissible values = 0…7

PGN = Parameter Group Number permissible = 0...262 143 = 0x00000000...0x0003FFFF number of the bytes to be transmitted permissible values = 0...8 data to be sent (1...8 bytes)

150



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

242

250

00

01

F2

FA




7969

151



J1939_TX_ENH_CYCLIC

= J1939 TX enhanced cyclic





7716

>

Description

J1939_TX_ENH_CYCLIC serves for cyclic transmitting of CAN messages.

Otherwise, the FB corresponds to J1939_TX_ENH (

→ p. 150 ).

► Set the period duration via the parameter PERIOD.

>

If a period is too short, this could lead to a high bus load!

The bus load can affect the performance of the complete system.


Parameter

ENABLE

CHANNEL

DA

Prio


PGN

Len


DATA

PERIOD

Data type

BOOL

BYTE

BYTE := 249

BYTE := 3

DWORD

BYTE := 8


TIME

Description








PGN = Parameter Group Number permissible = 0...262 143 = 0x00000000...0x0003FFFF number of the bytes to be transmitted permissible values = 0...8 data to be sent (1...8 bytes) period duration

7718

7719

152



>


Parameter

RESULT

Data type

BYTE


Value dec | hex

Description

0

8

242

00

08

F2

FB is inactive function block is active



7720



153



J1939_TX_ENH_MULTI

= J1939 TX enhanced multiframe message





7699

>

Description

7705

>

The transmission of multi-frame messages is carried out via J1939_TX_ENH_MULTI.

The FB corresponds to J1939_TX_ENH (

→ p. 150 ). In addition, it can be determined whether the

transmission shall be executed as BAM ( B roadcast A nnounce M essage).


Parameter

EXECUTE

CHANNEL

DA

Prio


PGN

Len


DATA

Bam


Data type

BOOL := FALSE

BYTE

BYTE := 249

BYTE := 3

DWORD

BYTE := 8


BOOL := FALSE

7712

Description






PGN = Parameter Group Number permissible = 0...262 143 = 0x00000000...0x0003FFFF number of the bytes to be transmitted permissible values = 0...8 data to be sent (1...1785 bytes)

BAM = Broadcast Announce Message = message to all participants

TRUE: multi-frame transmission as BAM message to all participants

FALSE: automatic; message only to target address

154



>



Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

8

65

242

00

01

08

41

F2


Error: transmission is not possible


7714

155




Function elements: SAE J1939 diagnosis

J1939_DM1RX .....................................................................................................................................157

J1939_DM1TX ......................................................................................................................................159

J1939_DM1TX_CFG ............................................................................................................................162

J1939_DM3TX ......................................................................................................................................163

15085

156



J1939_DM1RX

= J1939 Diagnostic Message 1 RX





14977

>

Description

7761

>

J1939_RX_DM1 receives diagnostic messages DM1 or DM2 from other ECUs.


Parameter

ENABLE

CHANNEL

DA

ACTIVE

Data type

BOOL := FALSE

BYTE

BYTE

BOOL

14979

Description






DA = Destination Address of the ECU from where the DTCs are to be retrieved.

DA = 254: read DTCs from the device itself

TRUE: Read active DTCs (DM1)

FALSE: Read previously active DTCs (DM2)

157



>



Parameter

REDSTOPLAMP

AMBERWARNINGLAMP

PROTECTLAMP

NUMBER

SPN

FMI

SPN_CM

OC

RESULT

MIL_FC

REDSTOPLAMP_FC

AMBERWARNINGLAMP_FC

PROTECTLAMP_FC

Data type

BOOL

BOOL

BOOL

BYTE

WORD

BYTE

BOOL

BYTE

BYTE

BYTE

BYTE

BYTE

BYTE


Value dec | hex

Description

0

1

8

242

00

01

08

F2

FB is inactive


FB is active – no data was received


Description red stop lamp (for older projects only)

TRUE: ON

FALSE: OFF

Amber warning lamp (for older projects only)

TRUE: ON

FALSE: OFF protect lamp (for older projects only)

TRUE: ON

FALSE: OFF number of the DTCs received (0...8)

Suspect Parameter Number (→ J1939 specification)

Failure Mode Indicator (→ J1939 specification) permissible values = 0...31 = 0x00...0x1F conversion method (→ J1939 specification) occurrence count feedback of the function block


Status of the electronic component:

Malfunction indicatation light status and flash code:

0 = off

1 = on

2 = flash slowly

3 = flash quickly

Status of the electronic component: red stop light status and flash code:

0 = off

1 = on

2 = flash slowly

3 = flash quickly


Yellow warning light status and flash code:

0 = off

1 = on

2 = flash slowly

3 = flash quickly

Status of the electronic component: protection light status and flash mode:

0 = off

1 = on

2 = flash slowly

3 = flash quickly

14980

158



J1939_DM1TX

= J1939 Diagnostic Message 1 TX





14993

>

Description

7747

With J1939_TX_DM1 (DM = D iagnostic M essage) the controller can only transmit an active error message to the CAN stack.

>

This message is stored in the hardware configuration.

> The message is marked "active" and transmitted once per second as DM1.

> If the error has already occurred, the event counter is incremented.

The event counter is managed by the CAN stack.

> A disjunction of all bits of the trouble codes is executed. As soon as a bit is set in one of the trouble codes, it is equally set in the lamp state.

Upon arrival of a request at DM2, the CAN stack can read the according information from the hardware configuration and transmit it.

> When a DM3 message arrives, all inactive errors are deleted in the error memory in the hardware configuration.

159



>


Parameter

EXECUTE

Data type

BOOL := FALSE

CHANNEL

ACTIVE

BYTE

BOOL

REDSTOPLAMP

AMBERWARNINGLAMP

PROTECTLAMP

SPN

FMI

SPN_CM

MIL_FC

BOOL

BOOL

BOOL

WORD

BYTE

BOOL

BYTE

REDSTOPLAMP_FC

AMBERWARNINGLAMP_FC

PROTECTLAMP_FC

BYTE

BYTE

BYTE


Description




TRUE: DTC is active

Cyclically transmitted (1x per second) as DM1

FALSE: DTC is no longer active

Saved in the hardware configuration

Transmitted as DM2 when requested red stop lamp (for older projects only)

TRUE: ON

FALSE: OFF

Amber warning lamp (for older projects only)

TRUE: ON

FALSE: OFF protect lamp (for older projects only)

TRUE: ON

FALSE: OFF

Suspect Parameter Number (→ J1939 specification)

Failure Mode Indicator (→ J1939 specification) permissible values = 0...31 = 0x00...0x1F conversion method (→ J1939 specification)


Malfunction indicatation light status and flash code:

0 = off

1 = on

2 = flash slowly

3 = flash quickly

Status of the electronic component: red stop light status and flash code:

0 = off

1 = on

2 = flash slowly

3 = flash quickly


Yellow warning light status and flash code:

0 = off

1 = on

2 = flash slowly

3 = flash quickly

Status of the electronic component: protection light status and flash mode:

0 = off

1 = on

2 = flash slowly

3 = flash quickly

14995

160



>



Parameter

RESULT

Data type

BYTE


Value dec | hex

Description

0

1

242

00

01

F2

FB is inactive data was marked "active" in the error memory




7750

161



J1939_DM1TX_CFG

= J1939 Diagnostic Message 1 TX configurable


Unit is contained in the library ifm_J1939_NT_V02.00.02.LIB

or higher



15424

>

>

Description

15426

As from runtime system V03.00.03 the CAN stack automatically sends a DM1 message every second as soon as the FB J1939_ENABLE (

→ p. 133 ) is called for the corresponding CAN interface.

► Use the FB J1939_DM1TX_CFG if you do not want the CAN stack to automatically and cyclically transmit DM1 messages.

The FB offers the following modes for cyclic transmission of DM1 messages:

MODE = 0

(preset)

The CAN stack sends DM1 "zero active faults" messages in compliance with standards every second.

A manual transmission of DM1 messages via the FB

J1939_DM1TX

(

→ p. 159 )is possible.

MODE = 1

MODE = 2

The CAN stack does not send DM1 "zero active faults" messages.

DM2 requests are answered automatically.

A manual transmission of DM1 messages via the FB J1939_DM1TX (

→ p. 159 ) is possible.

The CAN stack does not send cyclic DM1 "zero active faults" messages

Nor does the CAN stack automatically reply to DM2 requests.


15427

Parameter

ENABLE

CHANNEL

MODE

Data type

BOOL

BYTE

BYTE := 0

Description






Operating mode of the function block allowed = 0...2 (→ Description of the FB)

>


15429

Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

242

00

01

F2



162



J1939_DM3TX

= J1939 Diagnostic Message 3 TX





15002

>

Description

>

15004

With J1939_DM3TX (DM = D iagnostic M essage) you can delete the inactive DTCs on another device.

>

As soon as a DM3 message is received, all inactive errors in the error memory are deleted in the hardware configuration.


15006

Parameter

EXECUTE

CHANNEL

DA

Data type

BOOL := FALSE

BYTE

BYTE

Description




DA = Destination Address of the ECU on which the DTCs are to be deteled.

DA = 254: delete DTCs (DM2) in the device itself

>


15008

Parameter

RESULT

Data type

BYTE




0

Value dec | hex

00

Description

FB is inactive

1

242

01

F2 function block execution completed without error


163




5.2.5

Function elements: processing input values

FASTCOUNT ........................................................................................................................................165

INC_ENCODER ...................................................................................................................................167

INPUT ...................................................................................................................................................169

PERIOD ................................................................................................................................................171

STATUS_F_V_EXT ..............................................................................................................................174

1302

In this chapter we show you ifm FBs which allow you to read and process the analogue or digital signals at the device input.

164



FASTCOUNT

= Fast Count


Unit is contained in the library ifm_CR0431_Vxxyyzz.LIB



8112

>

Description

8114

FASTCOUNT operates as counter block for fast input pulses (up to 30 kHz).

This FB detects pulses at the fast input channels (



data sheet).

Overflow or underflow of the counter value is not detected.

14888

NOTE

>

In case of higher frequencies (higher than those guaranteed by ifm ) the following problems may occur:



The switch-on and switch-off times of the outputs become more important.



Undue heating of the components may occur.

The influences mentioned above depend on the components used in the individual case.

These possible influences cannot be exactly predicted.


8115

Parameter

ENABLE

CHANNEL

MODE

PRESET_VALUE

PRESET

Data type

BOOL

BYTE

BYTE

DWORD

BOOL

Description



> initiated processes continue in the background

> FB outputs are not updated

Number of the fast input channel

0...3 for the inputs I00...I03

Operating mode of the function block:

0 = 0x00 = stop counter

21 = 0x15 = upwards counter

22 = 0x16 = downwards counter counter start value

TRUE (for only 1 cycle): load the start value PRESET_VALUE

FALSE: counter is active

165



>



Parameter

VALUE

RESULT

Data type

DWORD

BYTE

Description ouput value feedback of the function block



Value dec | hex

Description

3

130

132

0

1

2

03

82

84

00

01

02

FB is inactive

FB execution completed without error – data is valid function block is active (action not yet completed) function block is active

– valid values not yet available channel setting is invalid mode setting is invalid

8116

166



INC_ENCODER

= Incremental Encoder





8134

>

Description

8135

INC_ENCODER handles up/down counter functions for the evaluation of encoders.

Two frequency inputs form the input pair which is evaluated by means of the FB.

Permissible limit frequency = 0...1 000 Hz

Via PRESET_VALUE the counter can be set to a preset value. The value is adopted if PRESET is set to TRUE. Afterwards, PRESET must be set to FALSE again for the counter to become active again.

The current counter value is available at the output VALUE. The outputs UP and DOWN indicate the last counting direction of the counter. The outputs are TRUE if the counter has counted in the corresponding direction. If the counter was not changed since the last call of the FB, both the outputs are FLASE.

On input RESOLUTION the resolution of the encoder can be evaluated in multiples:

1 = normal resolution (-536 870 912...536 870 911, identical with the resolution of the encoder),

2 = double evaluation of the resolution (-1 073 741 824...1 073 741 823),

4 = 4-fold evaluation of the resolution (-2 147 483 648...2 147 483 647).

All other values on this input mean normal resolution.

RESOLUTION = 1 counts for every fourth edge

(= resolution of the encoder).

RESOLUTION = 2 counts for every second edge

RESOLUTION = 4 counts for every rising and falling edge

167



>


Parameter

ENABLE

CHANNEL

PRESET_VALUE

PRESET

RESOLUTION

Data type

BOOL

BYTE

DINT

BOOL

BYTE


Description




> Function block outputs are not specified number of the input channel pair:

0 = channel pair 0 = inputs I00 + I01

2 = channel pair 1 = inputs I02 + I03 counter start value

FALSE  TRUE (edge):

PRESET_VALUE is loaded to COUNTER

TRUE: Counter ignores the input pulses

FALSE: Counter counts the input pulses evaluation of the encoder resolution:

01 = counts for every fourth edge (= resolution of the encoder)

02 = counts for every second edge

04 = counts for every rising and falling edge

All other values count as "01".

8137

>


Parameter

VALUE

UP

DOWN

RESULT

Data type

DINT

BOOL

BOOL

BYTE

Description if RESOLUTION = 1:

VALUE = –536 870 912...536 870 911

(= ¼ area of DINT) if RESOLUTION = 2:

VALUE = –1 073 741 824...1 073 741 823

(= ½ area of DINT) if RESOLUTION = 4:

VALUE = –2 147 483 648…2 147 483 647

(= area of DINT)

TRUE: counter counts upwards in the last cycle

FALSE: counter counts not upwards in the last cycle

TRUE: counter counts downwards in the last cycle

FALSE: counter counts not downwards in the last cycle feedback of the function block



Value dec | hex

Description

2

3

0

1

130

138

00

01

02

03

82

8A

FB is inactive

FB execution completed without error – data is valid function block is active (action not yet completed) function block is active – valid values not yet available channel setting is invalid resolution setting is invalid

168

8138



INPUT





8103

>

Description

INPUT enables determining the state at the input channels ( → data sheet). The FB provides the current state at the selected channel.

.

The measurement and the output value result from the operating mode indicated via MODE:

• binary input plus switching (BL) for positive sensor signal (with/without diagnosis)


• analogue input 0...20 mA



• analogue input ratiometric 0...32 V

• analogue input Resistance measurement 16...30 000 

The operating mode should not be changed during operation.

The analogue values are provided as standardised values.

19702

169



>



Parameter

ENABLE

CHANNEL

MODE

FILTER

Data type

BOOL

BYTE

BYTE

BYTE

19703

Description





Number of input channel

0...7 for the inputs IN0...IN7 operating mode of the input channel:

0 = 0x00 off


6 = 0x06 voltage input, ratiometric

7 = 0x07 current input


0…10 000 mV

0...1 000 ‰

0…20 000 µA

0…32 000 mV

11 = 0x0B

(only for analogue evaluated inputs) binary input, plus switching (BL) with diagnosis

(Namur)

12 = 0x0C binary input, minus switching (BH)

18 = 0x12 resistance input 16...30 000 Ω filter for the measurement on the input: valid= 0...8 recommended = 4

→ chapter Configure the software filters of the inputs

(→ p. 45 )

>


Parameter

VALUE

RESULT

Data type

WORD

BYTE

Description current value or status of the input channel

(according to the selected operating mode MODE) feedback of the function block



Value dec | hex

Description

3

130

132

136

141

0

1

2

142

144

00

01

02

03

82

84

88

8D

8E

90

FB is inactive


– data is valid function block is active (action not yet completed) function block is active

– valid values not yet available channel setting is invalid mode setting is invalid filter setting is invalid wire break occurred short to supply voltage occurred

Current at the input is too high

170

8106



PERIOD





8122

>

.

Description

15850

PERIOD measures the frequency in [Hz] or the period time (cycle time) in [µs] or the phase shift in [°] on the specified channel, depending on the set operating mode:

MODE dec | hex

Description

0

14

19

20

25

00 no measurement

0E Frequency measurement

Count the positive edges for a certain time.

13 Period duration measurement (better replace by MODE = 20!)

Measure the time interval between two positive edges.

Specify the average value over a certain number of periods.

14 Period duration and ratio measurement

Measure the time interval between two positive edges.

Specify the average value over a certain number of periods.

19 (LZS version 03.02.zz or higher)

Phase shift (0...359°) between channel A and channel B of an input channel pair

(message makes only sense if no great jumps > 179° can occur in the system)


If MODE=19 or MODE=20 or MODE=25:

permissible input frequency = 0.1...3 000 Hz

If the load is too high the cycle time can get unacceptably long.

→ chapter Performance limits of the device (

→ p. 31 )

14888

NOTE

In case of higher frequencies (higher than those guaranteed by ifm ) the following problems may occur:



The switch-on and switch-off times of the outputs become more important.



Undue heating of the components may occur.

The influences mentioned above depend on the components used in the individual case.

These possible influences cannot be exactly predicted.

171

MODE

PERIODS

TIMEBASE ifm Programming Manual BasicController relay CR0431 v03.03.00


>


Parameter

ENABLE

Data type

BOOL

CHANNEL BYTE

BYTE

BYTE

TIME


Description





(MODE = 14 / 19 / 20)

Number of the fast input channel

0...3 for the inputs IN0...IN3

(MODE = 25)

Number of the fast input A channel

0 / 2 for the inputs IN0 / IN2

B channel = A channel + 1


0 = 0x00 = no measurement

14 = 0x0E = frequency measurement

19 = 0x13 = interval measurement

20 = 0x14 = invertal and ratio measurement

25 = 0x19 = phase shift of two input signals

Number of periods to be averaged (1...4)

• if MODE = 19 / 20  average arithmetically

• if MODE = 25  average geometrically

• if PERIODS = 1  no averaging

(only relevant if MODE = 14) time for counting the edges in [ms] permissible values = 1...2 000

8124

172




>


8125

Parameter

VALUE_CYCLE

VALUE_FREQ

VALUE_TIME

VALUE_RATIO

RESULT

Data type

DWORD

REAL

TIME

WORD

BYTE


Value dec | hex

Description

130

132

137

146

2

3

0

1

82

84

89

92

00

01

02

03

FB is inactive

FB execution completed without error – data is valid function block is active (action not yet completed) function block is active – valid values not yet available channel setting is invalid mode setting is invalid value for PERIODS or TIMEBASE is invalid

Period duration is too long

Description

(MODE = 14 / 19 / 20)

Cycle time in [µs] at the input

(MODE = 25)

Cycle time in [µs] at the A channel of the input pair

(MODE = 14 / 19 / 20)

Frequency of the detected periods in [Hz] at the input

(MODE = 25)

Frequency of the detected periods in [Hz] at the A channel of the input pair

(MODE = 14)

Value = 0 (not detected)

(MODE = 19 / 20)

Time elapsed since the last positive edge

(MODE = 25)

Time elapsed since the last valid measurement

(MODE = 14)

Value = 0 (not detected)

(MODE = 19 / 20)

Mark-to-space ratio of the input signal in [‰]

(MODE = 25)

Phase shift in [°] feedback of the function block


173



STATUS_F_V_EXT

Unit type = program (PRG)

Unit is contained in the library ifm_CR0431_util_Vxxyyzz.LIB



19737

260

>

Description

The program STATUS_F_V_EXT determines the status of the fuse for the potential V_EXT.

The calculation basis is the measured VBBs value: SUPPLY_VOLTAGE_VBBS. voltage measured on the fuse ...

exceeds 70 % of VBBs

STAT_FUSE ...

changes to TRUE

> falls below 30 % of VBBs changes to FALSE


Parameter

STAT_FUSE

Data type

BOOL

Description

Status of the fuse:

TRUE = OK

FALSE = failled or not plugged in

19739

19740

174




5.2.6

Function elements: output functions

OUTPUT ...............................................................................................................................................176

PWM1000 .............................................................................................................................................178

RELAY ..................................................................................................................................................180

15075

10462

For this device you can set the mode of some or all outputs. Here we show you a couple of function elements to it.

175



OUTPUT





8078

.

>

>

Description

19721

OUTPUT assigns an operating mode to an output channel ( → data sheet). The FB enables the status detection on the selected output channel.

The measurement and the output value result from the operating mode indicated via MODE:

• binary output, plus switching (BH)


19707

Parameter

ENABLE

CHANNEL

VALUE

MODE

FILTER

Data type

BOOL

BYTE

BOOL

BYTE

BYTE

Description





Number of the output channel

0...5 for the outputs K00...K05

6...12 for the outputs LED00...LED06

TRUE: activate output

FALSE: deactivate output


0 = 0x00 = off

2 = 0x02 = binary output plus switching

only for outputs with current feedback: filter for the measurement on the output: valid = 0...8 recommended = 4

→ chapter Configure the software filters of the outputs

(→ p. 48 )

For outputs without current feedback:

FILTER = 0 or: do not set the parameter FILTER!


176



>



Parameter

OUTPUT

CURRENT

RESULT

Data type

BOOL

WORD

BYTE

Description

TRUE: output is activated

FALSE: output is deactivated only available for current controlable outputs: current output current in [mA] feedback of the function block



Value dec | hex

Description

128

129

130

132

2

3

0

1

136

141

80

81

82

84

00

01

02

03

88

8D

142

145

8E

91

FB is inactive

FB execution completed without error – data is valid function block is active (action not yet completed) function block is active – valid values not yet available undervoltage on VBBx overvoltage on VBBx channel setting is invalid mode setting is invalid filter setting is invalid a wire break was detected

(for binary output, plus switching (BH) with diagnosis) a short circuit was detected

(for binary output plus switching (BH) with diagnosis) current at the output is too high

(for binary output plus switching (BH) with diagnosis and protection)

8081

177



PWM1000





8060

>

Description

8062

PWM1000 handles the initialisation and parameter setting of the PWM outputs.

The FB enables a simple use of the PWM FB in the device. For each channel an own PWM frequency, the mark-to-space ratio and the dither can be set.

>

The PWM frequency FREQUENCY can be directly indicated in [Hz] and the mark-to-space ratio

VALUE in steps of 1 ‰.


Parameter

ENABLE

CHANNEL

FREQUENCY

VALUE

DITHER_FREQUENCY

DITHER_VALUE

Data type

BOOL

BYTE

WORD

WORD

WORD

WORD

19709

Description







PWM frequency in [Hz] allowed = 15 000...25 000 = 0x3A98...0x61A8

PWM value (mark-to-space ratio) in [‰] allowed = 0...1 000 = 0x0000...0x03E8

Values > 1 000 are regarded as = 1 000 dither frequency in [Hz] value range = 0...FREQUENCY / 2

FREQUENCY / DITHER_FREQUENCY must be even-numbered!

The FB increases all other values to the next matching value.

For relays at the output: value = 0 ! peak-to-peak value of the dither in [‰] permissible values = 0...1 000 = 0000...03E8

For relays at the output: value = 0 !

178



>



Parameter

CURRENT

RESULT

Data type

WORD

BYTE

Description only available for current controlable outputs: current output current in [mA] feedback of the function block



Value dec | hex

Description

3

128

130

131

0

1

2

133

134

03

80

82

83

00

01

02

85

86

FB is inactive

FB execution completed without error – data is valid function block is active (action not yet completed) function block is active

– valid values not yet available undervoltage on VBBx channel setting is invalid value for VALUE is invalid value for FREQUENCY is invalid dither setting is invalid

8523

179



RELAY


Unit is contained in the library ifm_CR0431_util_Vxxyyzz.LIB



19719

>

Description

19719

The FB RELAY switches the relay of the selected output channel with an adjustable voltage.

Possible use:

• Diagnostics of fuse and relay position

• Operation of 12-V relay on 24 V

• Reduction of the relay holding voltage (reduce energy consumption and heat loss)

Observe the data sheet of the relay used.

Example values for the relay: rated voltage operating voltage

24 V

14.4 V release voltage 3.6 V

REF_VOLTAGE indicates the reference voltage to calculate the threshold values of the status messages.

If REF_VOLTAGE > 32 000:

• value is not adopted

• error message RESULT = 140.

For the status messages: the measured voltage ...

the status message STAT-xx ...

exceeds 70 % of the reference voltage falls below 30 % of the reference voltage changes to TRUE changes to FALSE

The status messages indicate only meaningful values if the reference voltage used for calculating the

ON/OFF threshold is > tolerance of the voltage measurement for system voltages.

Bouncing of the relay (e.g. greater than 50 ms) can be visible via the status message. The status can indicate TRUE and FALSE several times alternately until the relay is in a stable state.

VOLTAGE = SUPPLY_VOLTAGE_VBBS_SW – 400 mV

(typical voltage drop on reverse-polarity-protection diode).

If VOLTAGE > (SUPPLY_VOLTAGE_VBBS_SW – 400 mV):

• output voltage = (SUPPLY_VOLTAGE_VBBS_SW – 400 mV).

If VOLTAGE > 32 000:

• value is not adopted

• error message RESULT = 140.

If VALUE = TRUE:

Relay indicates the voltage value in the parameter VOLTAGE (max. VBBs if it can be reached) on the

180



> relay coil (± 10 %).

RELAY uses the FB PWM1000 (

→ p. 178 ).

The effect of RELAY is not visible in the control configuration.


Parameter

ENABLE

CHANNEL

VALUE

REF_VOLTAGE


VOLTAGE


>


Data type

BOOL

BYTE

BOOL

WORD = 0

WORD = 0


Description







TRUE: activate output

FALSE: deactivate output

Reference voltage to calculate the status

• STAT_FUSE,

• STAT_NC,

• STAT_NO permissible = 0...32 000

0 / not used = SUPPLY_VOLTAGE_VBBS

Required relay coil voltage in [mV] permissible: 0...32 000

0 / not used = (SUPPLY_VOLTAGE_VBBS_SW – 400 mV)

19722

19725

Parameter

STAT_FUSE

STAT_NC

STAT_NO

RESULT

Data type

BOOL

BOOL

BOOL

BYTE


Value dec | hex

Description

0

1

2

128

130

140

00

01

02

80

82

8C

FB is inactive

FB execution completed without error – data is valid function block is active (action not yet completed) undervoltage on SUPPLY_VOLTAGE_VBBS_SW or: SUPPLY_SWITCH = FALSE channel setting is invalid channel does not exist or channel it no relay output value of VOLTAGE or REF_VOLTAGE is too high

Description

Status of the fuse:

TRUE = OK

FALSE = failled or not plugged in

Status of the relay's contact NC:

TRUE = contact closed

FALSE = contact opened

Status of the relay's contact NO:

TRUE = contact closed

FALSE = contact opened feedback of the function block


181




5.2.7

Function elements: system

FLASH_INFO .......................................................................................................................................183

FLASH_READ ......................................................................................................................................184

GET_APP_INFO ..................................................................................................................................185

GET_HW_INFO ....................................................................................................................................186

GET_IDENTITY ....................................................................................................................................187

GET_SW_INFO ....................................................................................................................................188

GET_SW_VERSION ............................................................................................................................189

MEM_ERROR ......................................................................................................................................190

MEMCPY ..............................................................................................................................................191

OHC ......................................................................................................................................................193

SET_IDENTITY ....................................................................................................................................195

SET_LED ..............................................................................................................................................196

SET_PASSWORD ................................................................................................................................198

TIMER_READ_US ...............................................................................................................................199

15067

Here we show you ifm functions that enable you to

• manage memory contents

• read information from software and hardware

• set or read various data and parameters

182



FLASH_INFO





11580

>

Description

>

FLASH_INFO reads the information from the user flash memory:

• name of the memory area (user defined),


• start address (for simple reading with IEC structure).


Parameter

ENABLE

Data type

BOOL

Description





>


Parameter

NAME

VERSION

START_ADDR

RESULT

Data type

STRING(24)

STRING(24)

DWORD

BYTE

Description

Name of the memory area (user defined)

Software version

Start address of the data feedback of the function block



Value dec | hex

Description

0

1

157

00

01

9D

FB is inactive


– data is valid

Software header invalid (CRC error)

11588

11589

11590

183



FLASH_READ





8147

>

Description

11579

>

FLASH_READ enables reading of different types of data directly from the flash memory.

The FB reads the contents as from the address of SRC from the flash memory. In doing so, as many bytes as indicated under LEN are transmitted.

► The address resulting from SRC + LEN must be < 65 408.

► To the destination address DST applies:

Determine the address by means of the operator ADR and assigne it to the POU!


8148

Parameter

ENABLE

DST

SRC

Data type

BOOL

DWORD

DWORD

WORD

Description




> Function block outputs are not specified destination address

Determine the address by means of the operator ADR and assigne it to the POU! relative start address in the memory valid = 0...65 407 = 0x0000 0000...0x0000 FF7F number (> 1) of the data bytes to be transmitted

>

LEN


8152

Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

152

00

01

98

FB is inactive


– data is valid inadmissible memory area:

• invalid source address

• invalid destination address

• invalid number of bytes

184



GET_APP_INFO

= get application information





11581

>

Description

>

GET_APP_INFO provides information about the application software stored in the device:

• name (= file name of the CODESYS project),

• version (= from CODESYS menu [Project] > [Project Info] > [Version]),

• unambiguous CoDeSys build number,

• CoDeSys build date.


Parameter

ENABLE

Data type

BOOL

Description





>


Parameter

NAME

VERSION

BUILD_NUM

BUILD_DATE

RESULT

Data type

STRING(24)

STRING(24)

STRING(24)

STRING(24)

BYTE

Description

Name of the application

Version of the application program

Unique CODESYS build number (e.g.: "45")

CODESYS build date (e.g.: "20111006123800") feedback of the function block



Value dec | hex

Description

0

1

00

01

FB is inactive


– data is valid

11593

11594

11595

185



GET_HW_INFO

= get hardware information





11582

>

Description

>

GET_HW_INFO provides information about the hardware of the device:

• ifm article number (e.g. CR0403),

• article designation,

• unambiguous serial number,

• hardware revision,

• production date.


1599

11600

Parameter

ENABLE

Data type

BOOL

Description





>


Parameter

ORDER_NUM

NAME

SERIAL

REVISION

MAN_DATE

RESULT

Data type

STRING(24)

STRING(24)

STRING(24)

STRING(24)

STRING(24)

BYTE

Description ifm article no. (e.g.: CR0403)

Article designation (e.g.: "BasicController 12/12")

Serial number of the device (e.g.: "000045784")

Hardware revision level of the device (e.g.: "V01.00.01")

Date of manufacture of the device (e.g.: "20111007123800") feedback of the function block



Value dec | hex

Description

0

1

00

01

FB is inactive


– data is valid

186

11601



GET_IDENTITY





8166

>

Description

>

15411

GET_IDENTITY reads the identification stored in the device (has previously been saved by means of

SET_IDENTITY (

→ p. 195 )).


8167

Parameter

ENABLE

Data type

BOOL

Description





>


8168

Parameter

APP_IDENT

RESULT

Data type

STRING(80)

BYTE

Description identifier of the application as a string of max. 80 characters, e.g.: "Crane1704" feedback of the function block



Value dec | hex

Description

0

1

155

00

01

9B

FB is inactive

FB execution completed without error – data is valid value could not be read

187



GET_SW_INFO

= get software information





11583

>

Description

>

GET_SW_INFO provides information about the system software of the device:

• software name,


• build number,

• build date.


Parameter

ENABLE

Data type

BOOL

Description





>


Parameter

NAME

VERSION

BUILD_NUM

BUILD_DATE

RESULT

Data type

STRING(24)

STRING(24)

STRING(24)

STRING(24)

BYTE

Description

Name of the system software (e.g.: "BasicSystem")

Version of the system software (e.g.: "V02.00.03")

Build number of the system software (e.g.: "45")

Build date of the system software (e.g.: "20111006123800") feedback of the function block



Value dec | hex

Description

0

1

00

01

FB is inactive


11596

11597

11598

188



GET_SW_VERSION

= get software version





14763

>

Description

>

GET_SW_VERSION provides information on the software in the device:

• BasicSystem version

• bootloader version

• SIS version

• IEC application program version

• IEC user flash version


Parameter

ENABLE

Data type

BOOL

Description





>


Parameter

BS_VERSION

BL_VERSION

SIS_VERSION

IEC_VERSION

USER_VERSION

RESULT

Data type

STRING(24)

STRING(24)

STRING(24)

STRING(24)

STRING(24)

BYTE

Description

Basic system version

Bootloader version

SIS version (SIS = System Information Service)

IEC application program version

IEC user flash version feedback of the function block



0

Value dec | hex

00

1 01

Description

FB is inactive


189

14765

14766

14767



MEM_ERROR

= Memory Error





14770

>

Description

>

MEM_ERROR signals errors in some parameters or in the memory.

The memory areas can be deleted via the corresponding FB inputs.


Parameter

ENABLE

RESET_RETAIN

RESET_OHC

>


Data type

BOOL

BOOL

BOOL

Description





TRUE: Delete non-volatile retain memory

FALSE: No changes to memory contents

TRUE: Delete non-volatile OHC memory

FALSE: No changes to memory contents

Parameter

COM_ERR

CALIB_ERR

RETAIN_ERR

OHC_ERR

RESULT

Data type

BOOL

BOOL

BOOL

BOOL

BYTE

Description

Download ID and baud rate are set to default values

(download parameters got lost)

Calibration values are invalid

(analogue inputs, PWM outputs, system voltages)

Retain memory is invalid

(e.g. partially deleted due to strong magnetic field)

OHC values are invalid

(e.g. partially deleted due to strong magnetic field) feedback of the function block



Value dec | hex

Description

0

1

00

01

FB is inactive


– data is valid

190

14772

14773

14774



MEMCPY

= memory copy





8160

>

Description

>

MEMCPY enables writing and reading different types of data directly in the memory.

The FB writes the contents of the address of SRC to the address DST.

► To the addresses SRC and DST apply:

Determine the address by means of the operator ADR and assigne it to the POU!

> In doing so, as many bytes as indicated under LEN are transmitted. So it is also possible to transmit exactly one byte of a word variable.


Parameter

ENABLE

DST

SRC

LEN

SWAP_TYPE

Data type

BOOL

DWORD

DWORD

WORD

BYTE

412

Description




> Function block outputs are not specified destination address

Determine the address by means of the operator ADR and assigne it to the POU! source address number (> 1) of the data bytes to be transmitted

Swap the byte sequence:

0 = no swapping e.g.: 1A 2B 3C 4D  1A 2B 3C 4D

1 = swap 2 bytes (WORD, INT, ...) e.g.: 1A 2B 3C 4D  2B 1A 4D 3C

LEN must be a multiple of 2!

2 = swap 4 bytes (DWORD, DINT, REAL, TIME, ...) e.g.: 1A 2B 3C 4D  4D 3C 2B 1A

LEN must be a multiple of 4!

8162

191



>



Parameter

RESULT

Data type

BYTE




0

Value dec | hex

00

Description

1

152

01

98

FB is inactive

FB execution completed without error – data is valid inadmissible memory area:

• invalid source address

• invalid destination address

• invalid number of bytes

156 9C inadmissible values:

• invalid value for SWAP_TYPE

• LEN does not match SWAP_TYPE

8163

192



OHC

= Operating Hours Counter





14777

>

Description

>

OHC provides 4 operating hours counters for universal use.

Valid counting range: 0:00...4 294 967 295:59 hours (= 490 293 years, 25 days, 15 hours)


Parameter

ENABLE

OHC_NUM

MODE

PRESET_HOURS

PRESET_MINUTES

Data type

BOOL

BYTE

BYTE

DWORD

BYTE

19712

Description





Operating Hours Counter

Number of the counter (0...3)

Operating mode of the counter permissible values =

0 = stop counter

1 = continue counting at the last stored value

2 = reset counter

3 = preset counter with the following values

Preset hours

(0...4 294 967 295 = 0x0000 0000...0xFFFF FFFF)

Preset minutes (0...59 = 0x00...0x3B)

19713

193



>



Parameter

HOURS

MINUTES

RESULT

Data type

DWORD

BYTE

BYTE

Description

Counter value hours

(0...4 294 967 295 = 0x0000 0000...0xFFFF FFFF)

Counter value minutes (0...59 = 0x00...0x3B) feedback of the function block



0

Value dec | hex

00

1 01

Description

FB is inactive


130

131

132

158

82

83

84

9E

Counter number in OHC_NUM is invalid

Preset value is invalid mode setting is invalid

Remanent memory is invalid (CRC error)

14780

194



SET_IDENTITY





8174

>

Description

>

SET_IDENTITY sets an application-specific program identification.

Using this FB, a program identification can be created by the application program.

► This identification can be read in order to identify the loaded program:

• via the software "Maintenance Tool"

• in the application program via the FB GET_IDENTITY (

→ p. 187 )


Parameter

ENABLE

APP_IDENT

Data type

BOOL

STRING(80)

Description




> Function block outputs are not specified identifier of the application as a string of max. 80 characters, e.g.: "Crane1704"

Reset with APP_IDENT = ""

>


Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

00

01

FB is inactive


– data is valid

8535

8175

8176

195



SET_LED





8052

>

Description

Via SET_LED frequency and color of the status LED can be changed in the application program.

>

If the flashing mode is changed in the application program, the default setting table is no longer valid (



chapter Status-LED (

→ p. 21 )).

8054


Parameter

ENABLE

COLOR_1

COLOR_2

FREQUENCY

Data type

BOOL

BYTE

BYTE

BYTE

8223

Description





LED color for "switched on" color constant from the data structure "System LED Color"; allowed:

00 = LED_BLACK (= LED out)

01 = LED_RED

02 = LED_GREEN

03 = LED_YELLOW

LED color for "switched off" color constant from the data structure "System LED Color"; allowed:

00 = LED_BLACK (= LED out)

01 = LED_RED

02 = LED_GREEN

03 = LED_YELLOW

LED flashing frequency

Frequency constant from the data structure "System LED Frequency"; allowed:

00 = LED_0HZ = permanently ON

01 = LED_05HZ = flashes at 0.5 Hz

02 = LED_1HZ = flashes at 1 Hz



196



>



Parameter

RESULT

Data type

BYTE




0

Value dec | hex

00

Description

FB is inactive

1

2

133

151

01

02

85

97 function block execution completed without error function block is active (action not yet completed) value for FREQUENCY is invalid value for color is invalid

8227

197



SET_PASSWORD





8178

>

>

Description

8179

SET_PASSWORD sets a user password for program and memory upload via the maintenance tool.

If the user password is active, reading of the application program or the data memory via the maintenance tool is only possible if the correct password has been entered.

If an empty string (default condition) is assigned to the PASSWORD input, the password is reset. Than an upload of the application software or of the data memory is possible at any time.

The password is reset when loading a new application program.


8180

Parameter

ENABLE

PASSWORD

Data type

BOOL

STRING(16)

Description




> Function block outputs are not specified password

If PASSWORD = "", than access is possible without enter of a password

>


8181

Parameter

RESULT

Data type

BYTE




Value dec | hex

Description

0

1

00

01

FB is inactive


– data is valid

198



TIMER_READ_US





8219

>

Description

660

TIMER_READ_US reads the current system time in [µs].

When the supply voltage is applied, the device generates a clock pulse which is counted upwards in a register. This register can be read by means of the FB call and can for example be used for time measurement.

Info

>

The system timer runs up to the counter value 4 294 967 295 µs at the maximum and then starts again from 0.

4 294 967 295 µs = 1h 11min 34s 967ms 295µs


8220

Parameter

TIME_US

RESULT

Data type

DWORD

BYTE

Description current system time [  s] feedback of the function block



Value dec | hex

Description

0

1

00

01

FB is inactive


199


Diagnosis and error handling

05 / 2018

Diagnosis

6 Diagnosis and error handling

>

Diagnosis ..............................................................................................................................................200

Fault ......................................................................................................................................................200

Response to system errors...................................................................................................................200

CAN / CANopen: errors and error handling..........................................................................................201

19598

The runtime-system (RTS) checks the device by internal error checks:

• during the boot phase (reset phase)

• during executing the application program

→ chapter O perating states (

→ p. 29 )

In so doing a high operating reliability is provided, as much as possible.

6.1

Diagnosis

>

During the diagnosis, the "state of health" of the device is checked. It is to be found out if and what

→faults are given in the device.

Depending on the device, the inputs and outputs can also be monitored for their correct function.

- wire break,

- short circuit,

- value outside range.

For diagnosis, configuration and log data can be used, created during the "normal" operation of the device.

The correct start of the system components is monitored during the initialisation and start phase.

Errors are recorded in the log file.

For further diagnosis, self-tests can also be carried out.

19601

6.2

Fault

>

19602

A fault is the state of an item characterized by the inability to perform the requested function, excluding the inability during preventive maintenance or other planned actions, or due to lack of external resources.

A fault is often the result of a failure of the item itself, but may exist without prior failure.

In →ISO 13849-1 "fault" means "random fault".

6.3

Response to system errors

8504

In principle, the programmer is responsible to react to the error messages in the application program.

An error description is provided via the error message.

>

The system resets the error message as soon as the error causing state is not present anymore.

200


Diagnosis and error handling

6.3.1

Example process for response to an error message

05 / 2018

CAN / CANopen: errors and error handling

8505

>

The runtime system cyclically writes the system flag TEMPERATURE.

The application program detects the device temperature by retrieving the INT variable.

If permissible values for the application are exceeded or not reached:

> The application program deactivates the outputs.

► Rectify the cause of the error.

> The application program detects the temperature value which has returned to normal:

The machine / system can be restarted or operation can be continued.

6.4

CAN / CANopen: errors and error handling

→ System manual "Know-How ecomat mobile "

→ chapter CAN / CANopen: errors and error handling

19604

201


Appendix

05 / 2018

System flags

7 Appendix

System flags .........................................................................................................................................202

Address assignment and I/O operating modes ....................................................................................204

Error tables ...........................................................................................................................................208

1664

Additionally to the indications in the data sheets you find summary tables in the appendix.

7.1

System flags

System flags: voltages ..........................................................................................................................203

System flags: inputs and outputs .........................................................................................................203

System flags: system ............................................................................................................................203

12167

The addresses of the system flags can change if the PLC configuration is extended.

► While programming only use the symbol names of the system flags!


→ chapter Error codes and diagnostic information

202


Appendix

05 / 2018

System flags

7.1.1

System flags (symbol name)

SUPPLY_VOLTAGE_VBB15

SUPPLY_VOLTAGE_VBBS

SUPPLY_VOLTAGE_VBBS_SW

SUPPLY_VOLTAGE_VU

Fnn

Knn_NC

Knn_NO

System flags: voltages

Type

WORD

WORD

WORD

WORD

WORD

WORD

WORD

Description supply voltage on VBB15 in [mV] supply voltage on VBBs in [mV] supply voltage on VBBs after SUPPLY_SWITCH in [mV] internal supply voltage in [mV]

Voltage behind fuse in Fnn in [mV] nn = number of the fuse

Voltage behind NC contact of relay Knn in [mV] nn = number of the relay

Voltage behind NO contact of relay Knn in [mV] nn = number of the relay

19746

>

>

7.1.2

System flags: inputs and outputs


INnn

Type

BOOL

Qxx xx = 00...15

LEDnn

BOOL

BOOL

Description

Status on binary input nn

Requirement: input is configured as binary input

(MODE = IN_DIGITAL_H or IN_DIGITAL_L)

TRUE: Voltage on binary input > 70 % of VBBS

FALSE: Voltage on binary input < 30 % of VBBS or: not configured as binary input or: wrong configuration

Status on binary output xx:

TRUE: output activated

FALSE: output deactivated

Status on LED output nn:

TRUE:LED activated

FALSE:LED deactivated

7.1.3

System flags: system


SUPPLY_SWITCH

Type

BOOL

INT

19747

19748

Description

Bit for switching off the supply latching VBBs.

Separation of VBBs is done before the next PLC cycle starts.

Depending on the charging status of the internal capacitors it may take some time until the device switches off.

TRUE: Supply of the device via VBBs is active

FALSE: Supply of the device via VBBs is deactivated

Temperature in the device in [°C] TEMPERATURE

203


Appendix

05 / 2018

Address assignment and I/O operating modes

7.2

Address assignment and I/O operating modes

Address assignment inputs / outputs ...................................................................................................204

Possible operating modes inputs/outputs .............................................................................................206

1656

→ also data sheet

7.2.1

Address assignment inputs / outputs

>

Inputs: address assignment..................................................................................................................204

Outputs: address assignment ...............................................................................................................205

2371

Inputs: address assignment

16654

Abbreviations →chapter Note on wiring

(

→ p. 20 )

Operating modes of the inputs/outputs →chapter Possible operating modes inputs/outputs

(

→ p. 206 )

IEC address Symbolic address

%IB00 IN00

%IB01

%IB02

%IB03

IN01

IN02

IN03

%IB04

%IB05

%IB06

%IB07

IN04

IN05

IN06

IN07

204


Appendix

05 / 2018


>

Outputs: address assignment

Abbreviations

→chapter Note on wiring

(

→ p.

20 )

Operating modes of the inputs/outputs →chapter Possible operating modes inputs/outputs (

→ p. 206 )

IEC address Symbolic address

%QB0

%QB1

K00

K01

%QB2

%QB3

%QB4

%QB5

K02

K03

K04

K05

%QB6

%QB7

%QB8

LED00

LED01

LED02

%QB9

%QB10

%QB11

%QB12

LED03

LED04

LED05

LED06

19798

205


Appendix

05 / 2018


7.2.2

Possible operating modes inputs/outputs

>

Inputs: operating modes .......................................................................................................................206

Outputs: operating modes ....................................................................................................................207

2386

Inputs: operating modes

16655

= this configuration value is default

Inputs Possible operating mode Set with function block

IN00…IN03 Off voltage input 0…10 000 mV

INPUT

INPUT

MODE

MODE voltage input ratiometric current input voltage input binary input

0…1 000 ‰

0…20 000 µA

0…32 000 mV plus switching

INPUT

INPUT

INPUT

INPUT

MODE

MODE

MODE

MODE binary input with diagnosis

(Namur) binary input frequency measurement plus switching minus switching

0…30 000 Hz period duration measurement 0.1...3 000 Hz period and ratio measurement 0.1...3 000 Hz upwards counter downwards counter

0…30 000 Hz

Phase difference detect encoder

IN04…IN07 off

0...359°

0…1 000 Hz binary input binary input with diagnosis

(Namur) plus switching plus switching resistance input 16…30 000 ohms

Set operating modes with the following function block:

INPUT

(→ p. 169 )

INPUT

INPUT

INPUT

INPUT

Assigns an operating mode to an input channel


Counter block for fast input pulses FASTCOUNT

(→ p. 165 )

INC_ENCODER

(→ p. 167 )

PERIOD

(→ p. 171 )

INPUT

INPUT

PERIOD

PERIOD

PERIOD

FASTCOUNT

PERIOD

INC_ENCODER

MODE

MODE

MODE

MODE

MODE

MODE

MODE

MODE

MODE

MODE

MODE


• measures at the indicated channel:

the frequency and the period length (cycle time) in [µs],

• measures at the indicated channel pair:

the phase shift in [°] between channel A and channel B

Function block input

11

20

21

22

25

12

14

19

0

10

11

18

9

10

6

7

dec

0

3

Value

hex

00

03

06

07

09

0A

0B

14

15

16

19

0C

0E

13

00

0A

0B

12

206


Appendix

05 / 2018


>

Outputs: operating modes

Outputs

= this configuration value is default

Possible operating mode Set with FB FB input

K00…K05 Off

Binary output plus-switching

OUTPUT

OUTPUT

MODE

MODE

LED00

…LED06

Binary output plus-switching

Set operating modes with the following function block:

OUTPUT

(→ p. 176 )

PWM1000 analogue output with pulse-width modulation

Off

(→ p. 178 )

PWM1000

OUTPUT

OUTPUT

MODE

MODE

Assigns an operating mode to an output channel


Initialises and configures a PWM-capable output channel the mark-to-space ratio can be indicated in steps of 1 ‰

19800

dec

0

2

Value

hex

00

02

0

2

00

02

207


Appendix

05 / 2018

Error tables

7.3

Error tables

>

Error flags .............................................................................................................................................208

Errors: CAN / CANopen ........................................................................................................................208

19606

7.3.1

Error flags

>

→ chapter System flags (

→ p. 202 )

7.3.2

Errors: CAN / CANopen

19608

19610

19604

>


→ chapter CAN / CANopen: errors and error handling

EMCY codes: CANx

13094

The indications for CANx also apply to each of the CAN interfaces.

00

10

11

30

EMCY code

object 0x1003

Byte 0

[hex]

00

Byte 1

[hex]

80

81

81

81

81

Object

0x1001

Byte 2

[hex]

11

11

11

11

11

Byte 3

--

--

--

--

--

Manufactor specific information

Byte 4

--

--

--

--

--

Byte 5

--

--

--

--

--

Byte 6

--

--

--

--

--

Byte 7 Description

--

--

--

--

--

CANx monitoring SYNC error (only slave)

CANx warning threshold (> 96)

CANx receive buffer overrun

CANx transmit buffer overrun

CANx guard/heartbeat error (only slave)

208


Appendix

05 / 2018

Error tables

>

EMCY codes: I/Os, system

8412

EMCY code

object 0x1003

Byte 0

[hex]

Byte 1

[hex]

08

00

00

00

08

10

00

08

00

23

31

33

21

21

21

23

33

42

03

05

05

05

09

Object

0x1001

Byte 2

[hex]

03

03

03

03

Byte 3

Manufactor specific information

Byte 4

I0 LSB

I0 LSB

I0 MSB

I0 MSB

I0 LSB I0 MSB

Q0 LSB Q0 MSB

Q0 LSB Q0 MSB

Byte 5 Byte 6

Byte 7 Description

Inputs interruption

Inputs short circuit

Excess current 4…20 mA

Outputs interruption

Outputs short circuit

Power supply VBBS

Terminal voltage VU

Output voltage VBB1, VBB2

Excess temperature

>

In the CANopen stack none of these EMCY codes are fix implemented. Advice:

► Make these EMCY codes with CANOPEN_SENDEMCYMESSAGE.

Manufacturer-specific information (detail)

24551

The EMCY codes of the manufacturer-specific information for the inputs and outputs (if available) are distributed as follows:

Byte BYTE 3

Bit 7 6 5 4 3 2 1 0

I0 LSB

Q0 LSB

IN07

OUT07

IN06

OUT06

IN05

OUT05

IN04

OUT04

IN03

OUT03

IN02

OUT02

IN01 IN00

OUT01 OUT00

Byte BYTE 4

Bit 7 6 5 4 3 2 1 0

I0 MSB

Q0 MSB

IN15

OUT15

IN14

OUT14

IN13

OUT13

IN12

OUT12

IN11

OUT11

IN10

OUT10

IN09 IN08

OUT09 OUT08

209


Terms and abbreviations

05 / 2018

8

A


Address

>

This is the "name" of the bus participant. All participants need a unique address so that the signals can be exchanged without problem.

Application software

>

Software specific to the application, implemented by the machine manufacturer, generally containing logic sequences, limits and expressions that control the appropriate inputs, outputs, calculations and decisions.

Architecture

>

Specific configuration of hardware and/or software elements in a system.

B

Baud

>

Baud, abbrev.: Bd = unit for the data transmission speed. Do not confuse baud with "bits per second"

(bps, bits/s). Baud indicates the number of changes of state (steps, cycles) per second over a transmission length. But it is not defined how many bits per step are transmitted. The name baud can be traced back to the French inventor J. M. Baudot whose code was used for telex machines.

1 MBd = 1024 x 1024 Bd = 1 048 576 Bd

>

Boot loader

On delivery ecomatmobile controllers only contain the boot loader.

The boot loader is a start program that allows to reload the runtime system and the application program on the device.

The boot loader contains basic routines...

• for communication between hardware modules,

• for reloading the operating system.

The boot loader is the first software module to be saved on the device.

Bus

>

Serial data transmission of several participants on the same cable.

C

CAN

>

CAN = C ontroller A rea N etwork

CAN is a priority-controlled fieldbus system for large data volumes. There are several higher-level protocols that are based on CAN, e.g. 'CANopen' or 'J1939'.

CAN stack

CAN stack = software component that deals with processing CAN messages.

210



05 / 2018

>

>

CiA

CiA = CAN in Automation e.V.

User and manufacturer organisation in Germany / Erlangen. Definition and control body for CAN and

CAN-based network protocols.

Homepage → www.can-cia.org

CiA DS 304

>

DS = D raft S tandard

CANopen device profile for safety communication

CiA DS 401

>


CANopen device profile for binary and analogue I/O modules

>

CiA DS 402


CANopen device profile for drives

>

CiA DS 403


CANopen device profile for HMI

>

CiA DS 404


CANopen device profile for measurement and control technology

>

CiA DS 405


CANopen specification of the interface to programmable controllers (IEC 61131-3)

>

CiA DS 406


CANopen device profile for encoders

CiA DS 407

>


CANopen application profile for local public transport

Clamp 15

In vehicles clamp 15 is the plus cable switched by the ignition lock.

211



05 / 2018

>

>

COB ID

COB = C ommunication Ob ject

ID = Id entifier

ID of a CANopen communication object

Corresponds to the identifier of the CAN message with which the communication project is sent via the

CAN bus.

>

CODESYS

CODESYS ® is a registered trademark of 3S – Smart Software Solutions GmbH, Germany.

'CODESYS for Automation Alliance' associates companies of the automation industry whose hardware devices are all programmed with the widely used IEC 61131-3 development tool CODESYS ®

Homepage → www.codesys.com

.

CSV file

CSV = C omma S eparated V alues (also: C haracter S eparated V alues)

A CSV file is a text file for storing or exchanging simply structured data.

The file extension is .csv

.

Example: Source table with numerical values: value 1.0

value 2.0

value 3.0

value 1.1

value 2.1

value 3.1

value 1.2

value 2.2

value 3.2

This results in the following CSV file:

.

> value 1.0;value 1.1;value 1.2;value 1.3

value 2.0;value 2.1;value 2.2;value 2.3

value 3.0;value 3.1;value 3.2;value 3.3

value 1.3

value 2.3

value 3.3

Cycle time

This is the time for a cycle. The PLC program performs one complete run.

Depending on event-controlled branchings in the program this can take longer or shorter.

212



05 / 2018

>

D

>

Data type

Depending on the data type, values of different sizes can be stored.

Data type min. value max. value

BOOL

BYTE

WORD

DWORD

SINT

USINT

INT

UINT

DINT

UDINT

REAL

ULINT

STRING

FALSE

0

0

0

-128

0

-32 768

0

-2 147 483 648

0

-3.402823466 • 10 38

0

TRUE

255

65 535

4 294 967 295

127

255

32 767

65 535

2 147 483 647

4 294 967 295

3.402823466 • 10 38

18 446 744 073 709 551 615

size in the memory

8 bits = 1 byte

8 bits = 1 byte

16 bits = 2 bytes

32 bits = 4 bytes

8 bits = 1 byte

8 bits = 1 byte

16 bits = 2 bytes

16 bits = 2 bytes

32 bits = 4 bytes

32 bits = 4 bytes

32 bits = 4 bytes

64 Bit = 8 Bytes number of char. + 1

>

DC

D irect C urrent

Diagnosis

During the diagnosis, the "state of health" of the device is checked. It is to be found out if and what

→faults are given in the device.

Depending on the device, the inputs and outputs can also be monitored for their correct function.

- wire break,

- short circuit,

- value outside range.

>

For diagnosis, configuration and log data can be used, created during the "normal" operation of the device.

The correct start of the system components is monitored during the initialisation and start phase.

Errors are recorded in the log file.

For further diagnosis, self-tests can also be carried out.

>

Dither

Dither is a component of the →PWM signals to control hydraulic valves. It has shown for electromagnetic drives of hydraulic valves that it is much easier for controlling the valves if the control signal (PWM pulse) is superimposed by a certain frequency of the PWM frequency. This dither frequency must be an integer part of the PWM frequency.

DLC

D ata L ength C ode = in CANopen the number of the data bytes in a message.

For →SDO: DLC = 8

213



05 / 2018

>

>

DRAM

DRAM = D ynamic R andom A ccess M emory.

Technology for an electronic memory module with random access (Random Access Memory, RAM).

The memory element is a capacitor which is either charged or discharged. It becomes accessible via a switching transistor and is either read or overwritten with new contents. The memory contents are volatile: the stored information is lost in case of lacking operating voltage or too late restart.

>

DTC

DTC = D iagnostic T rouble C ode = error code

In the protocol J1939 faults and errors well be managed and reported via assigned numbers – the

DTCs.

E

>

ECU

(1) E lectronic C ontrol U nit = control unit or microcontroller

(2) E ngine C ontrol U nit = control device of a engine

EDS-file

>

EDS = E lectronic D ata S heet, e.g. for:

• File for the object directory in the CANopen master,

• CANopen device descriptions.

Via EDS devices and programs can exchange their specifications and consider them in a simplified way.

>

Embedded software

System software, basic program in the device, virtually the →runtime system.

The firmware establishes the connection between the hardware of the device and the application program. The firmware is provided by the manufacturer of the controller as a part of the system and cannot be changed by the user.

EMC

>

EMC = E lectro M agnetic C ompatibility.

According to the EC directive (2004/108/EEC) concerning electromagnetic compatibility (in short EMC directive) requirements are made for electrical and electronic apparatus, equipment, systems or components to operate satisfactorily in the existing electromagnetic environment. The devices must not interfere with their environment and must not be adversely influenced by external electromagnetic interference.

EMCY

>

Abbreviation for emergency

Message in the CANopen protocol with which errors are signalled.

Ethernet

Ethernet is a widely used, manufacturer-independent technology which enables data transmission in the network at a speed of 10...10 000 million bits per second (Mbps). Ethernet belongs to the family of so-called "optimum data transmission" on a non exclusive transmission medium. The concept was developed in 1972 and specified as IEEE 802.3 in 1985.

214



05 / 2018

>

>

EUC

EUC = E quipment U nder C ontrol.

EUC is equipment, machinery, apparatus or plant used for manufacturing, process, transportation, medical or other activities ( → IEC 61508-4, section 3.2.3). Therefore, the EUC is the set of all equipment, machinery, apparatus or plant that gives rise to hazards for which the safety-related system is required.

If any reasonably foreseeable action or inaction leads to →hazards with an intolerable risk arising from the EUC, then safety functions are necessary to achieve or maintain a safe state for the EUC. These safety functions are performed by one or more safety-related systems.

F

>

FiFo

FIFO ( F irst I n, F irst O ut) = Operating principle of the stack memory: The data packet that was written into the stack memory first, will also be read first. Each identifier has such a buffer (queue).

Flash memory

>

Flash ROM (or flash EPROM or flash memory) combines the advantages of semiconductor memory and hard disks. Similar to a hard disk, the data are however written and deleted blockwise in data blocks up to 64, 128, 256, 1024, ... bytes at the same time.

Advantages of flash memories



The stored data are maintained even if there is no supply voltage.



Due to the absence of moving parts, flash is noiseless and insensitive to shocks and magnetic fields.

Disadvantages of flash memories



A storage cell can tolerate a limited number of write and delete processes:

• Multi-level cells: typ. 10 000 cycles

• Single level cells: typ. 100 000 cycles



Given that a write process writes memory blocks of between 16 and 128 Kbytes at the same time, memory cells which require no change are used as well.

>

FRAM

FRAM, or also FeRAM, means Fe rroelectric R andom A ccess M emory. The storage operation and erasing operation is carried out by a polarisation change in a ferroelectric layer.

Advantages of FRAM as compared to conventional read-only memories:

• non-volatile,

• compatible with common EEPROMs, but:

• access time approx. 100 ns,

• nearly unlimited access cycles possible.

H

>

Heartbeat

The participants regularly send short signals. In this way the other participants can verify if a participant has failed.

HMI

HMI = H uman M achine I nterface

215



05 / 2018

>

I

ID

>

ID = Id entifier

Name to differentiate the devices / participants connected to a system or the message packets transmitted between the participants.

IEC 61131

>

Standard: Basics of programmable logic controllers

• Part 1: General information

• Part 2: Production equipment requirements and tests

• Part 3: Programming languages

• Part 5: Communication

• Part 7: Fuzzy Control Programming

IEC user cycle

>

IEC user cycle = PLC cycle in the CODESYS application program.

Instructions

>

Superordinate word for one of the following terms: installation instructions, data sheet, user information, operating instructions, device manual, installation information, online help, system manual, programming manual, etc.

Intended use

>

Use of a product in accordance with the information provided in the instructions for use.

IP address

>

IP = I nternet P rotocol.

The IP address is a number which is necessary to clearly identify an internet participant. For the sake of clarity the number is written in 4 decimal values, e.g. 127.215.205.156.

>

ISO 11898

Standard: Road vehicles – Controller area network

• Part 1: Data link layer and physical signalling

• Part 2: High-speed medium access unit

• Part 3: Low-speed, fault-tolerant, medium dependent interface

• Part 4: Time-triggered communication

• Part 5: High-speed medium access unit with low-power mode

ISO 11992

Standard: Interchange of digital information on electrical connections between towing and towed vehicles

• Part 1: Physical and data-link layers

• Part 2: Application layer for brakes and running gear

• Part 3: Application layer for equipment other than brakes and running gear

• Part 4: Diagnostics

216



05 / 2018

>

>

ISO 16845

Standard: Road vehicles – Controller area network (CAN) – Conformance test plan

J

>

J1939

→ SAE J1939

L

LED

>

LED = L ight E mitting D iode.

Light emitting diode, also called luminescent diode, an electronic element of high coloured luminosity at small volume with negligible power loss.

Link

>

A link is a cross-reference to another part in the document or to an external document.

LSB

L east S ignificant B it/Byte

>

M

>

MAC-ID

MAC = M anufacturer‘s A ddress C ode

= manufacturer's serial number.

→ID = Id entifier

Every network card has a MAC address, a clearly defined worldwide unique numerical code, more or less a kind of serial number. Such a MAC address is a sequence of 6 hexadecimal numbers, e.g.

"00-0C-6E-D0-02-3F".

Master

>

Handles the complete organisation on the bus. The master decides on the bus access time and polls the →slaves cyclically.

Misuse

>

The use of a product in a way not intended by the designer.

The manufacturer of the product has to warn against readily predictable misuse in his user information.

MMI

→ HMI (

→ p. 215 )

217



05 / 2018

>

>

MRAM

MRAM = M agnetoresistive R andom A ccess M emory

The information is stored by means of magnetic storage elements. The property of certain materials is used to change their electrical resistance when exposed to magnetic fields.

Advantages of MRAM as compared to conventional RAM memories:

• non volatile (like FRAM), but:

• access time only approx. 35 ns,

• unlimited number of access cycles possible.

MSB

>

M ost S ignificant B it/Byte

N

>

NMT

NMT = N etwork M anagemen t = (here: in the CANopen protocol).

The NMT master controls the operating states of the NMT slaves.

Node

>

This means a participant in the network.

Node Guarding

>

Node = here: network participant

Configurable cyclic monitoring of each →slave configured accordingly. The →master verfies if the slaves reply in time. The slaves verify if the master regularly sends requests. In this way failed network participants can be quickly identified and reported.

O

>

Obj / object

Term for data / messages which can be exchanged in the CANopen network.

Object directory

>

Contains all CANopen communication parameters of a device as well as device-specific parameters and data.

>

OBV

Contains all CANopen communication parameters of a device as well as device-specific parameters and data.

OPC

OPC = O LE for P rocess C ontrol

Standardised software interface for manufacturer-independent communication in automation technology

OPC client (e.g. device for parameter setting or programming) automatically logs on to OPC server

(e.g. automation device) when connected and communicates with it.

218



05 / 2018

>

>

Operational

Operating state of a CANopen participant. In this mode →SDOs, →NMT commands and →PDOs can be transferred.

P

>

PC card

→PCMCIA card

PCMCIA card

>

PCMCIA = Personal Computer Memory Card International Association, a standard for expansion cards of mobile computers.

Since the introduction of the cardbus standard in 1995 PCMCIA cards have also been called PC card.

>

PDM

PDM = P rocess and D ialogue M odule.

Device for communication of the operator with the machine / plant.

>

PDO

PDO = P rocess D ata O bject.

The time-critical process data is transferred by means of the "process data objects" (PDOs). The

PDOs can be freely exchanged between the individual nodes (PDO linking). In addition it is defined whether data exchange is to be event-controlled (asynchronous) or synchronised. Depending on the type of data to be transferred the correct selection of the type of transmission can lead to considerable relief for the →CAN bus.

According to the protocol, these services are unconfirmed data transmission: it is not checked whether the receiver receives the message. Exchange of network variables corresponds to a "1 to n connection" (1 transmitter to n receivers).

>

PDU

PDU = P rotocol D ata U nit = protocol data unit.

The PDU is a term from the →CAN protocol →SAE J1939. It refers to a component of the target address (PDU format 1, connection-oriented) or the group extension (PDU format 2, message-oriented).

PES

>

P rogrammable E lectronic S ystem ...

• for control, protection or monitoring,

• dependent for its operation on one or more programmable electronic devices,

• including all elements of the system such as input and output devices.

PGN

PGN = P arameter G roup N umber

PGN = 6 zero bits + 1 bit reserved + 1 bit data page + 8 bit PDU Format (PF) + 8 PDU Specific (PS)

The parameter group number is a term from the →CAN protocol →SAE J1939.

219



05 / 2018

>

>

Pictogram

Pictograms are figurative symbols which convey information by a simplified graphic representation.

( → chapter What do the symbols and formats mean?

(

→ p. 6 ))

>

PID controller

The PID controller (proportional –integral–derivative controller) consists of the following parts:

• P = proportional part

• I = integral part

• D = differential part (but not for the controller CR04nn, CR253n).

>

PLC configuration

Part of the CODESYS user interface.

► The programmer tells the programming system which hardware is to be programmed.

>

CODESYS loads the corresponding libraries.

> Reading and writing the periphery states (inputs/outputs) is possible.

Pre-Op

>

Pre-Op = PRE-OPERATIONAL mode.

Operating status of a CANopen participant. After application of the supply voltage each participant automatically passes into this state. In the CANopen network only →SDOs and →NMT commands can be transferred in this mode but no process data.

>

Process image

Process image is the status of the inputs and outputs the PLC operates with within one →cycle.



At the beginning of the cycle the PLC reads the conditions of all inputs into the process image.

During the cycle the PLC cannot detect changes to the inputs.



During the cycle the outputs are only changed virtually (in the process image).



At the end of the cycle the PLC writes the virtual output states to the real outputs.

PWM

>

PWM = pulse width modulation

The PWM output signal is a pulsed signal between GND and supply voltage.

Within a defined period (PWM frequency) the mark-to-space ratio is varied. Depending on the mark-to-space ratio, the connected load determines the corresponding RMS current.

R

ratiometric

>

Measurements can also be performed ratiometrically. If the output signal of a sensor is proportional to its suppy voltage then via ratiometric measurement (= measurement proportional to the supply) the influence of the supply's fluctuation can be reduced, in ideal case it can be eliminated.

→ analogue input

RAW-CAN

RAW-CAN means the pure CAN protocol which works without an additional communication protocol on the CAN bus (on ISO/OSI layer 2). The CAN protocol is international defined according to

ISO 11898-1 and garantees in ISO 16845 the interchangeability of CAN chips in addition.

220



05 / 2018

>

>

remanent

Remanent data is protected against data loss in case of power failure.

The →runtime system for example automatically copies the remanent data to a →flash memory as soon as the voltage supply falls below a critical value. If the voltage supply is available again, the runtime system loads the remanent data back to the RAM memory.

The data in the RAM memory of a controller, however, is volatile and normally lost in case of power failure.

>

ro

RO = read only for reading only

Unidirectional data transmission: Data can only be read and not changed.

>

RTC

RTC = R eal T ime C lock

Provides (batter-backed) the current date and time. Frequent use for the storage of error message protocols.

Runtime system

>

Basic program in the device, establishes the connection between the hardware of the device and the application program.

→ chapter Software modules for the device (

→ p. 23 )

>

rw

RW = read/ write

Bidirectional data transmission: Data can be read and also changed.

S

>

SAE J1939

The network protocol SAE J1939 describes the communication on a →CAN bus in commercial vehicles for transmission of diagnosis data (e.g.engine speed, temperature) and control information.

Standard: Recommended Practice for a Serial Control and Communications Vehicle Network

• Part 2: Agricultural and Forestry Off-Road Machinery Control and Communication Network

• Part 3: On Board Diagnostics Implementation Guide

• Part 5: Marine Stern Drive and Inboard Spark-Ignition Engine On-Board Diagnostics Implementation

Guide

• Part 11: Physical Layer – 250 kBits/s, Shielded Twisted Pair

• Part 13: Off-Board Diagnostic Connector

• Part 15: Reduced Physical Layer, 250 kBits/s, Un-Shielded Twisted Pair (UTP)

• Part 21: Data Link Layer

• Part 31: Network Layer

• Part 71: Vehicle Application Layer

• Part 73: Application Layer – Diagnostics

• Part 81: Network Management Protocol

SD card

An SD memory card (short for S ecure D igital Memory Card) is a digital storage medium that operates to the principle of →flash storage.

221



05 / 2018

>

SDO

SDO = S ervice D ata O bject.

The SDO is used for access to objects in the CANopen object directory. 'Clients' ask for the requested data from 'servers'. The SDOs always consist of 8 bytes.

>

Examples:

• Automatic configuration of all slaves via →SDOs at the system start,

• reading error messages from the →object directory.

Every SDO is monitored for a response and repeated if the slave does not respond within the monitoring time.

Self-test

>

Test program that actively tests components or devices. The program is started by the user and takes a certain time. The result is a test protocol (log file) which shows what was tested and if the result is positive or negative.

>

Slave

Passive participant on the bus, only replies on request of the →master. Slaves have a clearly defined and unique →address in the bus.

>

stopped

Operating status of a CANopen participant. In this mode only →NMT commands are transferred.

>

Symbols

Pictograms are figurative symbols which convey information by a simplified graphic representation.

( → chapter What do the symbols and formats mean?

(

→ p. 6 ))

System variable

>

Variable to which access can be made via IEC address or symbol name from the PLC.

T

Target

>

The target contains the hardware description of the target device for CODESYS, e.g.: inputs and outputs, memory, file locations.

Corresponds to an electronic data sheet.

TCP

>

The T ransmission C ontrol P rotocol is part of the TCP/IP protocol family. Each TCP/IP data connection has a transmitter and a receiver. This principle is a connection-oriented data transmission. In the

TCP/IP protocol family the TCP as the connection-oriented protocol assumes the task of data protection, data flow control and takes measures in the event of data loss. (compare: →UDP)

Template

A template can be filled with content.

Here: A structure of pre-configured software elements as basis for an application program.

222



05 / 2018

>

U

UDP

>

UDP ( U ser D atagram P rotocol) is a minimal connectionless network protocol which belongs to the transport layer of the internet protocol family. The task of UDP is to ensure that data which is transmitted via the internet is passed to the right application.

At present network variables based on →CAN and UDP are implemented. The values of the variables are automatically exchanged on the basis of broadcast messages. In UDP they are implemented as broadcast messages, in CAN as →PDOs.

According to the protocol, these services are unconfirmed data transmission: it is not checked whether the receiver receives the message. Exchange of network variables corresponds to a "1 to n connection" (1 transmitter to n receivers).

Use, intended

>

Use of a product in accordance with the information provided in the instructions for use.

W

Watchdog

In general the term watchdog is used for a component of a system which watches the function of other components. If a possible malfunction is detected, this is either signalled or suitable program branchings are activated. The signal or branchings serve as a trigger for other co-operating system components to solve the problem.

223

9 Index

A

About this manual .................................................................................... 4

Activate the PLC configuration .............................................................. 39

Activation of the input diagnosis ............................................................ 46

Address ................................................................................................ 210

Address assignment and I/O operating modes ................................... 204

Address assignment inputs / outputs .................................................. 204

Analogue inputs ..................................................................................... 14 configuration and diagnosis .......................................................................... 44

Appendix .............................................................................................. 202

Application program ............................................................................... 24

Application software............................................................................. 210

Architecture .......................................................................................... 210

Available memory .................................................................................. 13

B

Baud ..................................................................................................... 210

Binary inputs .......................................................................................... 15

Binäry inputs configuration and diagnosis .......................................................................... 46

Boot loader .......................................................................................... 210

Bootloader.............................................................................................. 24

Bus ....................................................................................................... 210

C

CAN ..................................................................................................... 210 interfaces and protocols ................................................................................ 22

CAN / CANopen errors and error handling............................................................................. 201

CAN declaration (e.g. CR1080) ............................................................. 40

CAN interfaces ....................................................................................... 22

CAN stack ............................................................................................ 210

CAN_ENABLE ....................................................................................... 61

CAN_RECOVER ................................................................................... 62

CAN_REMOTE_REQUEST .................................................................. 83

CAN_REMOTE_RESPONSE................................................................ 84

CAN_RX ................................................................................................ 67

CAN_RX_ENH ....................................................................................... 68

CAN_RX_ENH_FIFO ............................................................................ 70

CAN_RX_RANGE ................................................................................. 72

CAN_RX_RANGE_FIFO ....................................................................... 74

CAN_SETDOWNLOADID ..................................................................... 63

CAN_STATUS ....................................................................................... 64

CAN_TX ................................................................................................. 77

CAN_TX_ENH ....................................................................................... 78

CAN_TX_ENH_CYCLIC ........................................................................ 80

CANOPEN_ENABLE ............................................................................. 87

CANOPEN_GETBUFFERFLAGS ......................................................... 89

CANOPEN_GETEMCYMESSAGES ................................................... 126

CANOPEN_GETERRORREGISTER .................................................. 128

CANOPEN_GETGUARDHBERRLIST ................................................ 122

CANOPEN_GETGUARDHBSTATSLV ............................................... 123

CANOPEN_GETNMTSTATESLAVE .................................................... 96

CANOPEN_GETODCHANGEDFLAG ................................................ 100

CANOPEN_GETSTATE ........................................................................ 91

CANOPEN_GETSYNCSTATE ............................................................ 118

CANOPEN_NMTSERVICES ................................................................. 97

CANOPEN_READOBJECTDICT ........................................................ 101

CANOPEN_SDOREAD ....................................................................... 105

224

CANOPEN_SDOREADBLOCK ........................................................... 107

CANOPEN_SDOREADMULTI ............................................................ 109

CANOPEN_SDOWRITE ..................................................................... 111

CANOPEN_SDOWRITEBLOCK ......................................................... 113

CANOPEN_SDOWRITEMULTI........................................................... 115

CANOPEN_SENDEMCYMESSAGE .................................................. 130

CANOPEN_SETSTATE ........................................................................ 93

CANOPEN_SETSYNCSTATE ............................................................ 120

CANOPEN_WRITEOBJECTDICT ...................................................... 102

CiA ....................................................................................................... 211

CiA DS 304 .......................................................................................... 211

CiA DS 401 .......................................................................................... 211

CiA DS 402 .......................................................................................... 211

CiA DS 403 .......................................................................................... 211

CiA DS 404 .......................................................................................... 211

CiA DS 405 .......................................................................................... 211

CiA DS 406 .......................................................................................... 211

CiA DS 407 .......................................................................................... 211

Clamp 15.............................................................................................. 211

COB ID ................................................................................................. 212

CODESYS ........................................................................................... 212

Configuration of the inputs (default setting) .......................................... 42

Configurations ........................................................................................ 34

Configure inputs ..................................................................................... 43

Configure outputs .................................................................................. 48

Configure the software filters of the inputs ............................................ 45

Configure the software filters of the outputs .......................................... 48

Control the LED in the application program .......................................... 21

Copyright.................................................................................................. 4

Creating application program ................................................................ 28

CSV file ................................................................................................ 212

Cycle time ............................................................................................ 212

D

Data type.............................................................................................. 213

DC ........................................................................................................ 213

Description 61, 62, 63, 64, 67, 68, 70, 72, 74, 77, 78, 80, 83, 84, 87, 89,

91, 93, 96, 97, 100, 101, 102, 105, 107, 109, 111, 113, 115, 118, 120,

122, 123, 126, 128, 130, 133, 135, 137, 139, 141, 142, 144, 145, 147,

149, 150, 152, 154, 157, 159, 162, 163, 165, 167, 169, 171, 174, 176,

178, 180, 183, 184, 185, 186, 187, 188, 189, 190, 191, 193, 195, 196,

198, 199

Diagnosis .................................................................................... 200, 213

Diagnosis and error handling............................................................... 200

Distribution of the application program .................................................. 29

Dither ................................................................................................... 213

DLC ...................................................................................................... 213

DRAM .................................................................................................. 214

DTC ...................................................................................................... 214

E

ECU ..................................................................................................... 214

EDS-file ................................................................................................ 214

Embedded software ............................................................................. 214

EMC ..................................................................................................... 214

EMCY ................................................................................................... 214

EMCY codes

CANx ........................................................................................................... 208

I/Os, system ................................................................................................. 209

Error flags ............................................................................................ 208

ERROR state ......................................................................................... 31

Error tables .......................................................................................... 208

Errors


Index

CAN / CANopen .......................................................................................... 208

Ethernet ............................................................................................... 214

EUC ..................................................................................................... 215

Example process for response to an error message .......................... 201

F

Fast inputs ............................................................................................. 47

FASTCOUNT ....................................................................................... 165

FATAL ERROR state ............................................................................. 31

Fault ..................................................................................................... 200

FB, FUN, PRG in CODESYS ................................................................ 26

FiFo ...................................................................................................... 215

Flash memory ...................................................................................... 215

FLASH memory ..................................................................................... 13

FLASH_INFO ....................................................................................... 183

FLASH_READ ..................................................................................... 184

FRAM .............................................................................................13, 215

Function configuration in general .......................................................... 41

Function configuration of the inputs and outputs .................................. 42

Function element outputs ...................................................................... 59

Function elements

CANopen ....................................................................................................... 86

CANopen emergency .................................................................................. 125

CANopen guarding ...................................................................................... 121

CANopen network management ................................................................... 95

CANopen object directory ............................................................................. 99

CANopen SDOs .......................................................................................... 104

CANopen status ............................................................................................ 86

CANopen SYNC .......................................................................................... 117 output functions ........................................................................................... 175 processing input values............................................................................... 164

RAW-CAN (Layer 2) ...................................................................................... 60

RAW-CAN remote ......................................................................................... 82

RAW-CAN status ........................................................................................... 60 receive RAW-CAN data ................................................................................ 66 receive SAE J1939 ...................................................................................... 143

SAE J1939 ................................................................................................... 132

SAE J1939 diagnosis .................................................................................. 156

SAE J1939 request ..................................................................................... 140

SAE J1939 status ........................................................................................ 132 system ......................................................................................................... 182 transmit RAW-CAN data ............................................................................... 76 transmit SAE J1939 .................................................................................... 148

Fuses, relays ......................................................................................... 18

G

GET_APP_INFO .................................................................................. 185

GET_HW_INFO ................................................................................... 186

GET_IDENTITY ................................................................................... 187

GET_SW_INFO ................................................................................... 188

GET_SW_VERSION ........................................................................... 189

H

Hardware description ............................................................................. 11

Hardware structure ................................................................................ 11

Heartbeat ............................................................................................. 215

History of the instructions (CR043n) ..................................................... 7

HMI ...................................................................................................... 215

How is this documentation structured? ................................................... 7

I

ID ......................................................................................................... 216

225

05 / 2018

IEC 61131 ............................................................................................ 216

IEC user cycle ...................................................................................... 216 ifm function elements ............................................................................. 53 ifm function elements for the device CR0431 ....................................... 58 ifm libraries for the device CR0431 ....................................................... 53

Important note to program the device .............................................12, 27

INC_ENCODER ................................................................................... 167

Information about the device ................................................................. 10

INIT state (Reset) .................................................................................. 29

INPUT .................................................................................................. 169

Input group IN0...IN3 ............................................................................. 16

Input group IN4...IN7 ............................................................................. 16

Inputs address assignment .................................................................................... 204 operating modes .......................................................................................... 206

Inputs (technology) ................................................................................ 14

Instructions .......................................................................................... 216

Intended use ........................................................................................ 216

Interface description .............................................................................. 22

IP address ............................................................................................ 216

ISO 11898 ............................................................................................ 216

ISO 11992 ............................................................................................ 216

ISO 16845 ............................................................................................ 217

J

J1939 ................................................................................................... 217

J1939_DM1RX .................................................................................... 157

J1939_DM1TX ..................................................................................... 159

J1939_DM1TX_CFG ........................................................................... 162

J1939_DM3TX ..................................................................................... 163

J1939_ENABLE ................................................................................... 133

J1939_GETDABYNAME ..................................................................... 135

J1939_NAME ....................................................................................... 137

J1939_RX ............................................................................................ 144

J1939_RX_FIFO .................................................................................. 145

J1939_RX_MULTI ............................................................................... 147

J1939_SPEC_REQ ............................................................................. 141

J1939_SPEC_REQ_MULTI ................................................................ 142

J1939_STATUS ................................................................................... 139

J1939_TX............................................................................................. 149

J1939_TX_ENH ................................................................................... 150

J1939_TX_ENH_CYCLIC ................................................................... 152

J1939_TX_ENH_MULTI ...................................................................... 154

L

LED ...................................................................................................... 217

LED outputs ........................................................................................... 49

Libraries ................................................................................................. 25

Library ifm_CANopen_NT_Vxxyyzz.LIB................................................ 56

Library ifm_CR0431_util_V03yyzz.LIB .................................................. 55

Library ifm_CR0431_V03yyzz.LIB ........................................................ 54

Library ifm_J1939_NT_Vxxyyzz.LIB ..................................................... 57

Library ifm_RAWCan_NT_Vxxyyzz.LIB ................................................ 55

Limitations for CAN in this device .......................................................... 32

Limitations for CAN J1939 in this device ............................................... 33

Limitations for CANopen in this device.................................................. 33

Link ...................................................................................................... 217

LSB ...................................................................................................... 217


Index

M

MAC-ID ................................................................................................ 217

Manufacturer-specific information (detail) ........................................... 209

Master .................................................................................................. 217

MEM_ERROR ..................................................................................... 190

MEMCPY ............................................................................................. 191

Misuse .................................................................................................. 217

MMI ...................................................................................................... 217

MRAM .................................................................................................. 218

MSB ..................................................................................................... 218

N

Network variables .................................................................................. 52

NMT ..................................................................................................... 218

Node .................................................................................................... 218

Node Guarding .................................................................................... 218

Note on wiring ........................................................................................ 20

Note the cycle time! ............................................................................... 27

Notes serial number ................................................................................................... 9

Notizen • Notes • Notes ....................................................................... 228

O

Obj / object ........................................................................................... 218

Object directory .................................................................................... 218

OBV ..................................................................................................... 218

OHC ..................................................................................................... 193

OPC ..................................................................................................... 218

Operating states .................................................................................... 29

Operational .......................................................................................... 219

OUTPUT .............................................................................................. 176

Output group K0...K5 ............................................................................. 18

Output group LED0...LED6 .................................................................... 19

Outputs address assignment .................................................................................... 205 operating modes .......................................................................................... 207

Outputs (technology) ............................................................................. 18

Overview documentation modules for CR0431 .............................................................. 5

P

Parameters of the inputs ... 61, 62, 63, 64, 67, 68, 70, 72, 74, 77, 78, 80,

83, 84, 87, 89, 91, 93, 96, 97, 100, 101, 102, 105, 108, 109, 111, 114,

115, 118, 120, 122, 123, 126, 128, 130, 133, 136, 138, 139, 141, 142,

144, 145, 147, 149, 150, 152, 154, 157, 160, 162, 163, 165, 168, 170,

172, 174, 176, 178, 181, 183, 184, 185, 186, 187, 188, 189, 190, 191,

193, 195, 196, 198

Parameters of the outputs . 61, 63, 65, 67, 69, 71, 73, 75, 77, 79, 81, 83,

85, 88, 90, 92, 94, 96, 98, 100, 101, 103, 106, 108, 110, 112, 114, 116,

119, 120, 122, 124, 127, 129, 131, 134, 136, 138, 139, 141, 142, 144,

146, 147, 149, 151, 153, 155, 158, 161, 162, 163, 166, 168, 170,173,

177, 179, 181, 183, 184, 185, 186, 187, 188, 189, 190, 192, 194, 195,

197, 198, 199

PC card ................................................................................................ 219

PCMCIA card ....................................................................................... 219

PDM ..................................................................................................... 219

PDO ..................................................................................................... 219

PDU ..................................................................................................... 219

Performance limits of the device ........................................................... 31

PERIOD ............................................................................................... 171

PES ...................................................................................................... 219

226

05 / 2018

PGN ..................................................................................................... 219

Pictogram ............................................................................................. 220

PID controller ....................................................................................... 220

PLC configuration ................................................................................ 220

Please note .............................................................................................. 8

Possible operating modes inputs/outputs ........................................... 206

Pre-Op ................................................................................................. 220

Principle block diagram ......................................................................... 12

Process image ..................................................................................... 220

Programming notes for CODESYS projects ......................................... 26

Protective functions of the outputs ........................................................ 18

PWM .................................................................................................... 220

PWM1000 ............................................................................................ 178

R ratiometric ............................................................................................ 220

RAW-CAN ............................................................................................ 220

Read back retain variables .................................................................... 51

Reinstall the runtime system ................................................................. 35

RELAY ................................................................................................. 180

Relay outputs ......................................................................................... 49 remanent .............................................................................................. 221

Resistance measurement ...................................................................... 17

Response to system errors .................................................................. 200

Retain variables ..................................................................................... 51 ro .......................................................................................................... 221

RTC ...................................................................................................... 221

RUN state .............................................................................................. 30

Runtime system .............................................................................24, 221 rw ......................................................................................................... 221

S

SAE J1939 ........................................................................................... 221

Safety instructions ................................................................................... 8

Safety instructions about Reed relays .............................................20, 43

Save retain variables ............................................................................. 51

SD card ................................................................................................ 221

SDO ..................................................................................................... 222

Self-test ................................................................................................ 222

Set up the programming system ........................................................... 37

Set up the programming system manually ............................................ 37

Set up the programming system via templates ..................................... 41

Set up the runtime system ..................................................................... 34

Set up the target .................................................................................... 38

SET_IDENTITY ................................................................................... 195

SET_LED ............................................................................................. 196

SET_PASSWORD ............................................................................... 198

Slave .................................................................................................... 222

Software description .............................................................................. 23

Software modules for the device ........................................................... 23

SRAM ..................................................................................................... 13

Start conditions ...................................................................................... 12

Start-up behaviour of the controller ......................................................... 9

STATUS_F_V_EXT ............................................................................. 174

Status-LED ............................................................................................ 21

STOP state ............................................................................................ 30 stopped ................................................................................................ 222

Symbols ............................................................................................... 222

System description ................................................................................ 10

System flags ........................................................................................ 202


Index inputs and outputs ....................................................................................... 203 system ......................................................................................................... 203 voltages ....................................................................................................... 203

System variable ................................................................................... 222

System variables ................................................................................... 41

T

Target ................................................................................................... 222

TCP ...................................................................................................... 222

Template .............................................................................................. 222

TIMER_READ_US............................................................................... 199

U

UDP ..................................................................................................... 223

Update the runtime system .................................................................... 36

Use as binary inputs .............................................................................. 47

Use, intended ....................................................................................... 223

Using ifm maintenance tool ................................................................... 29

V

Variables ................................................................................................ 50

Verify the installation ............................................................................. 36

W

Watchdog ............................................................................................. 223

Watchdog behaviour .............................................................................. 32

What do the symbols and formats mean? ............................................... 6

What previous knowledge is required? ................................................... 8

05 / 2018

227

10 Notizen • Notes • Notes

228