IPM telegram definition

(1)

IPM-DataTelegram_Client_Gateway_v6.0.2.0_en.docx Page 1 of 48

IPM

telegram definition

- The industrial standard -

In General:

(2)

IPM-DataTelegram_Client_Gateway_v6.0.2.0_en.docx Page 2 of 48 Legal information

Disclosing this document to third parties is not permitted.

Furthermore, technical utilization and its implementation for third party providers is not permitted. CSP GmbH & Co. KG is the sole owner of copyrights.

(3)

0 Table of Contents

0 Table of Contents ... 3

1 Index of changes ... 5

2 Introduction ... 6

2.1 Version control ... 6

3 Telegram Components ... 6

4 Method for calculating the Checksum ... 6

5 General Remarks ... 7

6 IPM Telegram ... 8

6.1 Telegram Header [Field-ID 01xx] ... 8

6.2 Transfer Parameters [Field-ID 02xx] ... 8

6.3 Component at location [Field-ID 03xx] ... 9

6.4 Measuring Data [Field-ID 10xx]... 10

6.5 Location data [Field-ID 15xx] ... 11

6.6 Tool information [Field-ID 20xx] ... 12

6.6.1 Further tool information [Field-ID 21xx] ... 12

6.7 Module information group [Field-ID 25xx]... 13

6.7.1 Module information [Field-ID 26xx] ... 13

6.8 Worker information [Field-ID 30xx] ... 13

6.9 Additional information [Field-ID 32xx] ... 13

6.10 Error / rework message [Field-ID 40xx] ... 14

6.10.1 Error code [Field-ID 42xx] ... 14

6.10.2 Rework message [Field-ID 45xx] ... 14

6.10.3 Problem description [Field-ID 46xx] ... 15

6.11 Used parts [Field-ID 50xx] ... 16

6.11.1 Additional information for the used part [Field-ID 51xx] ... 16

6.11.2 Mounted parts [Field-ID 52xx] ... 16

6.12 Step [Field-ID 60xx] ... 17

6.13 Settings [Field-ID 65xx] ... 18

6.13.1 Setting parameter [Field-ID 66xx] ... 18

6.14 Characteristic Data ... 19

6.14.1 User-specific mark tagging [Field-ID 71xx] ... 19

6.14.2 Mark example ... 20

6.15 Parameter ... 21

6.15.1 User-specific parameter [Field-ID 76xx] ... 21

6.15.2 User-specific parameter tagging [Field-ID 77xx] ... 21

6.16 Trace [Field-ID 80xx] ... 22

6.17 Checksum [Field-ID 90xx] ... 22

7 Acknowledgement ... 23

7.1 Acknowledge header ... 23

7.2 User Data... 23

8 Life-Telegram ... 24

8.1 Life telegram ... 24

9 RFC 1006 communication ... 24

10 Tables ... 24

10.1 Table „Acknowledgement error codes“ ... 24

(4)

10.1.2 2xxxx: Data in wrong format ... 25

10.1.3 3xxxx: Value out of range / Value is invalid ... 30

10.1.4 4xxxx: Mandatory information missing ... 34

10.1.5 5xxxx: logical errors ... 39

10.1.6 6xxxx: Error in trace definition ... 41

11 Behavior in case of error or time out ... 42

11.1 No errors ... 42

11.2 Errors ... 43

11.3 Time Out ... 44

12 Data Format ... 45

12.1 Intel Format (little endian) ... 45

12.1.1 Definition ... 45

12.2 Network byte order (big endian) ... 46

12.2.1 Definition ... 46

12.2.2 Examples ... 46

13 Remarks about traces ... 47

14 Examples ... 48

14.1 Acknowledgement / Checksum ... 48

14.2 Telegram without curve ... 48

14.3 Telegram with curve ... 48

14.3.1 Angle transferred by increment and start value, torque by curve values ... 48

14.3.2 Angle and Torque as Curve Values ... 48

(5)

1 Index of changes

Version Date Change

6.0.0.0 26/05/2015 Changes since version 5.2

6.0.0.1 24/08/2015 - Inconsistencies in 6.14.2 regarding the length of starting value, increments resolved - Inconsistencies in the curve regarding feature reference corrected

- Manufacturer identification: missing mandatory field identification and error code 41000 supplemented

- Value range field 2110 corrected and error code 42111 supplemented - Processing text for worker information (30xx) supplemented

- Value range field 3210 corrected and error code 43211 supplemented - Processing text for rework message (45xx) supplemented

- Processing text for problem description (46xx) supplemented - Value range field 5110 corrected and error code 45111 supplemented 6.0.0.2 08/09/2015 - Chapter 6.14 Feature data: in the text "99" corrected to "200"

- Error code 57003: "99" corrected to "200"

- Missing error codes 52100 and 53200 supplemented

6.0.1.0 06/03/2016 - Value range for field 0390, "Number of measurements", corrected to "1 – 99" - Clarification of term field 1080, number of installation results

(6)

2 Introduction

Communication between the IPM Gateway and a facility is done via a TCP/IP connection.

The IPM Gateway is the server and the facility is the client, which establishes and releases the connection. To prevent connections from staying alive for unlimited time, the IPM Gateway can close a connection when there is no communication within a certain amount of time.

2.1 Version control

The version number consists of 4 digits.

The first digit determines the telegram version (6).

The second digit is changed when minor structural changes are made to the telegram.

The third position changes if restrictions are relaxed (e.g. value range is enlarged, mandatory information becomes optional information).

The fourth digit points to error corrections.

3 Telegram Components

A Telegram consists of several components. These are: * Telegram Header * Transfer Parameters * Component at location +Measuring Data +Install hierarchy +Steps +Characteristic Data +Trace * Checksum

The asterisk (*) marks mandatory elements of the telegram components.

The hash (#) marks fields that can be used as filter in the IPM web application. A filter can be: a tree node, an input field, a selection box, etc. Not every field can be filtered in all the standard areas or reports.

The Telegram Header contains information about the telegram itself like version, sequence number or length.

The Transfer Parameters define, whether binary data (trace values) is transferred in Intel Byte Order (little endian) or in network byte order (big endian). Additionally, there can be transmitted a GUID for a telegram to avoid duplicate transmissions.

The Maintenance Sequence (AFO) describes a unique event and is only identifying element in IPM to allocate data to a certain point in process.

The Characteristic Data contains a measured value with its parameters. A trace represents the progress of a measurement related to the characteristics.

With every telegram there is exactly one measurement transferred, that may contain more than one value.

It is only possible to send the next telegram after the foregoing telegram was acknowledged. It is necessary to send the telegrams in chronological order for every facility.

4 Method for calculating the Checksum

The checksum is built by applying XOR on all the bytes of the telegram in sequence. (Result R = Byte B0 XOR Byte B1; R = R XOR B2; R = R XOR B3 ;…)

The byte that contains the checksum is not included in the checksum calculation.

(7)

5 General Remarks

All fields are aligned left and get filled up with blanks.

With exception of the trace values, all data is transmitted in text form. Numbers are not transferred in binary form. The dot “.” is defined as decimal separator for all values (except trace values, because they are binary coded). In the description of the components the symbol “” represents a blank for illustrating reasons.

Names and identifications for characteristics (e.g. WI and MI), parameters, status and mode are not contained in this definition. These are listed in another document (EXCEL File). Please contact us, if you want the additional file. If there are not all identifications that are possible by the manufacturer, it is necessary to report this to CSP to make an add-on. This list is called “attachment” in this document.

A view in national language (multilingualism) is done by the evaluation software.

To enable the transfer of negative trace values the field “Algebraic Sign” is present in the characteristic, which indicates if there are only positive or also negative trace values (according to the corresponding characteristics) transferred.

If a fixed increment value is given, this field has to be set to “” (blank).

Since all other values are transferred in text format, the “

-

“character is prefixed if the value is negative. The byte length of the trace values is set to 1, 2, or 4 bytes. An accurate definition follows in the part “Trace”.

Because trace values are always transferred as integer values (1, 2, or 4 bytes), the factor gives the number of decimal places. To represent very big values in a smaller way, a negative factor is possible. So the decimal separator is always moved by the specified number of digits. A corresponding table is given beneath.

It is possible to transfer more than one step in one trace. To make it possible to transfer measured values for every step, the step to which the measured value corresponds, is added to the characteristic block.

Every telegram is acknowledged by the IPM Gateway.

A checksum is attached to the data as well as to the acknowledgement telegram.

When restarting the client, AAAA is sent as first sequence number. The next sequence number is 1. Thereby the

synchronization is restarted every time the client is restarted. After the sequence number is oversized (9999+1), it is necessary to start again with 0.

After establishing a connection the first telegram can have any sequence number.

The only sequence number that produces an error is that one used with the last ok acknowledged telegram. This is done to prevent repeating the last telegram. All other sequence numbers are allowed so that controllers need not change any sequence numbers already set in telegrams in a buffer when the controller can’t send telegrams for a long time and has to delete the oldest buffer entries. The lower numbers are also allowed because of a possibly occurred “roll over” after 9999.

The fields “Identification”, “Version” and “Character Code” in the telegram header and also in the acknowledgement header may only consist of characters, which are part of the ASCII character set (US-ASCII).

The asterisk (*) marks mandatory fields in the telegram. The plus (+) marks fields or blocks that are mandatory, when a corresponding field is set. When a field is optional (not marked with ‘*’ or optional because of a ‘+’) it has to be filled with blanks. For example the mode in the measuring data is optional, but the bytes are assigned with this field so that the value can be empty (filled with blanks).

IPM recognizes parameter changes on its own. A parameter change occurs if at least one parameter value changes or the parameters transmitted for the feature change (e.g. parameter is added or omitted). A parameter change also takes place if the unit of the feature changes.

(8)

6 IPM Telegram

6.1 Telegram Header [Field-ID 01xx]

Field Length

[Bytes] Format t- text b- binary

Range of Values / Code

Comment Field-

ID *Source 8 t _{e.g. CSP.0001}

_:

_{controller of firm CSP with}

sequence number 1

0100 *Target 8 t The targeted system, e.g. IPM.0001 is IPM. If

there are several installations, the number gives the targeted installation.

0101 *Identification 8 t IPM-DATA identification of the telegram 0110

*Version Major 2 t 6

(integer)

version of the telegram (for version

identification see page 1) 0111

Minor 2 t 0

(integer)

0112 *Character Code 20 t US-ASCII or

ISO-8859-1

all other codes depend on the platform on which IPM is installed 0120 *Sequence Number 4 t 0 – 9999 (integer) resp. AAAA

sequence number of the telegram; is generated by the control unit 0130 *Length of User Data 8 t 0 –

999999 (integer)

including checksum, but without telegram header (first field included: Byte Order)

0140

The information from the telegram header is used for the acknowledgement telegram.

6.2 Transfer Parameters [Field-ID 02xx]

Field Length

[Bytes] Format t- text b- binary Range of Values / Code Comment Field- ID *Byte order 2 t 0, 1 (integer)

0 = Intel byte order (little endian)

1 = network byte order (big endian) description see “Data Format” on page 45

0200

GUID *length 2 t 0-99

(integer)

Length of the transmitted GUID

0210

value len t GUID for unique identification of the telegram. If the GUID is sent it can be used to prevent duplicate entries in IPM. When the value of the GUID has been sent to IPM for any source, then the data will not be written to IPM.

(9)

6.3 Component at location [Field-ID 03xx]

The field “type” is used in IPM inter alia for distinction between parameter. In this case there can be used, e. g. at type 1, other tolerances and nominal values as at type 2. If it is the same type, changes on the parameter result in recognition of a parameter change.

The field “variation” is for further distinction within a type. But it is NOT used for the distinction between parameter. If the field “location” does not give an explicit value (global process, station or other grouping element for every joints, which are listed in the following telegram), the AFO of the first measurement has to be used.

Field Length

[Byte] Format t = Text b = binary

Range of Values /

Code Comment / Example Field-ID

#Ident-Nr. *length 4 t 0 – 40

(integer)

Length of the following ident number 0300 value len t Vehicle identification number, motor number,

etc. 0301

#Additional

ID *length 4 t 0(integer) - 10

Length of the following value 0310

value len t e.g. serial number 0311

#Object number *length 4 t 0 – 255

(integer)

Length of the following object number 0320

value len t 0321

#Type *length 2 t 0 – 99

(integer)

Length of the following type 0330 value len t e. g. description of vehicle model 0331 Variation *length 2 t 0 – 99

(integer)

Length of the following variation value 0340 value len t e. g. description of vehicle variation 0341 *Location *length 2 t 1 – 99

(integer)

Length of the following location value 0350

*value len t e. g. station name 0351

*#Status 2 t 0 – 99

(integer)

0 = ok. 1 =not ok

Further possible values look enclosure

(10)

6.4 Measuring Data [Field-ID 10xx]

An AFO describes the position on which des measurements will be carried out, e. g. bolting position, welding point or filling station.

The data set will be assigned clearly in IPM by AFO.

In the AFO allowed are every alphanumeric letters (a-z, A-Z, 0-9) as well as the symbols “_” (underscore) “-“ (minus/hyphen) “.” (dot).

Field Length

Comment / Example Field

-ID *manufacturer code 6 t Possible values look enclosure 1000 *station type 4 t 0 – 9999

(integer)

Possible values look enclosure 1001

*#Date 10 t dd.MM.yyyy Measuring date

(d = day, M = month, y = year) 1005 *#Time 8 t hh:mm:ss Measuring time (in 24-hours-notation)

(h = hour, m = minute, s = second) 1006 *#AFO *Length 4 t 1 – 30

(integer)

Length of the following value 1010 *Value len t Clear description of the job sequence 1011 Bolting process *Length 2 0 – 16

(integer)

Value t Bolting process 1013

#AFO text *Length 4 t 0 – 50

(integer)

Value len t Naming of the job sequence 1016

Program

number *Length 4 t 0(integer) – 4

Value len t Program number 1018

*Number of location data 2 0 – 10

(integer) 1020 Per location information +[locaction information] Working

process *Length 4 t 0(integer) – 99

Value len t e. g. wheel bolting process 1026

Connection number

*Length 4 t 0 – 255

(integer)

Value len t e. g. welding point number 1031

Connection

name *Length 4 t 0(integer) – 100

Value len t Name of the connection 1033

Connection technology 10 t Possible values look enclosure 1035 *Number of tool information 2 t 0 – 99

(integer)

Number of transferred tool information 1040 Per tool

information +[ informationtool ] *Number of module inforamion

groups 2 t 0(integer) – 99

Number of transferred module information

groups 1045 Per module information group +[Module information group] #Component carrier ID *Length 2 t 0 – 10 (integer)

(11)

Field Length

Range of Values /

Code Comment / Example Field-ID

*Trace available 2 t 0, 1 (integer) 0 = without trace 1 = with trace 1055 *#Status 2 t 0 – 99 (integer) 0 = ok 1 = not ok

1060

Mode 2 t 0 – 99

(integer)

possible values look enclosure 1061 Additional status 2 t 0 – 99

(integer)

possible values look enclosure 1062 Last step of process reached 2 t 0, 1

(integer)

 = no information

0 = last step not reached

1 = last step reached

106

3

*Number of worker information 2 t 0 – 10

(integer)

Number of transferred worker information 1065 Per worker

information +[ informationWorker ] *Number of additional

information 2 t 0(integer) – 10

Number of the following additional information

blocks 1070 For every additional information +[Additional information] *Number of error / rework messages

2 t 0 – 99

(integer)

Number of the following error or rework messages 1075 Per error / rework message +[Error / rework message]

*Number of install results 2 t 0 – 99

(integer)

Gives the number of „result parts“, which were produced at this AFO 1080 For every install

result

+[Installed parts] t The (assembled) result parts, which are leaving the process (e. g. one motor, which comes to the next process step after the process) *Number of steps 2 t 0 – 99

(integer)

Number of the following steps with

characteristic blocks 1085 For each step +[Step]

+[Trace]

6.5 Location data [Field-ID 15xx]

Describes the location of the measuring point and matches the position of the AFO at IPM tree. Every structure type may be used just one single time at a measurement.

Field Length

Comment Field

-ID *Structure type Length 2 t 0 – 30

(integer)

Length of the following value 1500 Value len t Matches the node type at IPM tree 1501 *Structure name *Length 2 t 0 – 30

(integer)

Value len t Name of the node at iPM tree 1511

(12)

6.6 Tool information [Field-ID 20xx]

It HAS TO be marked exact one of the tools as main tool.

Field Length

[Byte] Format t = Text b = binary Range of Values / Code Comment Field-ID *Main tool 2 t 0, 1 (integer)

0 = Not the main tool, but e. g. the robot, which leads the main tool

1 = main tool; e. g. the screw which carries out the process

2000

*tool type 10 t e. g. screwdriver, robot; possible values look

enclosure 2005

Serial number *Length 2 t 0 – 30

(integer)

Length of the serial number

At the main tool this matches the previous tool ID

2010

Value len t Serial number 2011

Manufacturer *Length 2 t 0 – 30

(integer)

Length of the manufacturer 2015

Value len t Manufacturer 2016

Model *Length 2 t 0 – 30

(integer)

Length of the model 2020

Value len t Model 2021

*Number of further tool

information 2 t 0(integer) – 99

2030 For every furth

tool information +[ tool Further information]

6.6.1 Further tool information [Field-ID 21xx]

Field Length

Range of Values /

Code Comment Field-ID

*Meaning tool information 4 t 0 – 9999

(integer)

What represents the additional tool information?

Possible values look enclosure

2100 Further tool

information *Length 4 t 1(integer) – 255

(13)

6.7 Module information group [Field-ID 25xx]

Field Length

Range of Values /

Information group 2 t Module information with the same group will be considered matching (within a group a meaning may be happen just one time).

2500 *Number of module information 2 t 1 – 99

(integer)

Number of the following module information 2501 *[Module

information] len t

6.7.1 Module information [Field-ID 26xx]

Field Length

Range of Values /

*Information type 2 t 1 – 99

(integer)

Information type e .g. master data; possible

values look enclosure 2600 *Sort of information 6 t Information about what this information

represents (e. g. a existing-state-counter); possible values look enclosure

2601 *Data type of the value 2 t 0, 1

(integer)

0 = numeric (float)

1 = text

2610 If data type = 0 Num. Value 16 t float Numeric value 2611 If data type = 1 *Length 4 t 0 – 255

(integer)

Length of the text value 2612

Text value len t Text value 2613

6.8 Worker information [Field-ID 30xx]

If the length of the worker ID = 0 or at a length > 0 the worker ID only consists of blank spaces, this worker information block will be rated as not available.

Field Length

Range of Values /

Worker ID *Length 2 t 0 – 99

(integer)

Length of the worker ID 3000

Value len t Worker ID 3001

Protection level 2 t 3010

6.9 Additional information [Field-ID 32xx]

Field Lengt h [Byte] Format t = Text b = binary Range of Values /

*Meaning additional information 6 t 0 – 999999

(integer)

What represents the additional information? Possible values look enclosure

3200 Information *Length 4 t 1 – 255

(integer)

(14)

6.10 Error / rework message [Field-ID 40xx]

Field Length

Range of Values /

*message type 2 t 0, 1 (integer) 0 = error message 1 = rework message 4000 If message type = 0 *[ codeerror ] If message type = 1 *[ messagerework ] *[Problem description]

6.10.1 Error code [Field-ID 42xx]

Field Length

Comment Field

-ID *error code type 2 t 0, 1, 2

(integer)

0 = no error code

1 = IPM standard error code

2 = user-specific error code

4200

If error code type

= 1 *error code 6 t 0(integer) – 999999

6 byte for every error code; Possible values look enclosure

4210 If error code type

= 2 *[specific error User-code]

User-specific error code

6.10.1.1 User-specific error code [Field-ID 43xx]

Field Length

Comment Field

-ID *Error code *Length 2 t 1 – 9

(integer)

Length of the error code value 4300

*Value len t Error code 4301

*Meaning *Length 4 t 1 – 100

(integer)

Length of the error code meaning 4310

*Value len t Errorcode meaning 4311

6.10.2 Rework message [Field-ID 45xx]

If the length of the job = 0 or at a length > 0 the job only consists of blank spaces, this rework message will be rated as not available.

Field Length

Range of Values /

Job *Length 4 t 0 – 500

(integer)

Length of the job description 4510

(15)

6.10.3 Problem description [Field-ID 46xx]

If the length of the condition = 0 or at a length > 0 the value of the condition only consists of blank spaces, the condition will be rate does not available.

Field Length

Range of Values /

Component *Length 2 t 0 – 99

(integer)

4600 Value len t Location of the problem, e. g. „bonnet“ 4601 Kind of

problem *Length 2 t 0(integer) – 99

4610

Value len t Kind of problem, e. g. “dented” 4611

*[Location]

*Number of conditions 2 0 – 99

(integer)

4630 Per condition *Length 2 t 0 – 99

(integer)

4631 Value len t Condition under what the problem occurs, e. g.

„in Winter“ 4632

6.10.3.1 Location [Field-ID 47xx]

Field Length

[Byte] Format t = Text b = binary Range of Values / Code Comment Field -ID *Type of location 2 t 0, 1, 2 (integer) 0 = no location information 1 = 3D coordinate

2 = text 4700 If type of

location = 1 X-coordinate Y-coordinate 16 16 t t floatfloat 4710 4711

Z-coordinate 16 t float 4712

If type of

location = 2 *Length 2 0(integer) – 99

(16)

6.11 Used parts [Field-ID 50xx]

Field Length

Range of Values /

*#Object

number *Length 4 t 1(integer) – 255

Length of the item number value 5000

*Value len t Item number 5001

*#Identification

number *Length 4 t 1(integer) – 255

Length of the identification number 5005

*Value len t Identification number 5006

#Part code *Length 2 t 0 – 16

(integer)

Length of the part code 5010

Value len t Part code 5011

#mark / identification

*Length 2 t 0 – 10

(integer)

Length of the mark 5015

Value len t e. g. if serial part, buyed part 5016 #Supplier *Length 4 t 0 – 255

(integer)

Length of the supplier value 5020

Value len t Supplier 5021

Number of parts 4 t 0 – 9999

(integer)

Gives the number of the parts, e. g. of charge 5025 *Number of additional

information for the used part 2 t 0(integer) – 99

Gives the number of the following additional

information 5030

Per additional information for the used part

*[Additional information for the used part]

6 t

*Number of mounted parts 2 t 0 – 99

(integer)

How many parts are needed to create the object number?

5040

+[Mounted parts] Parts, which are used to create the object

number

6.11.1 Additional information for the used part [Field-ID 51xx]

Field Length

Range of Values /

Meaning used additional information

*Length 2 t 1 – 6

(integer)

How long is the following data? 5100 *Value len t What represents the additional

information?

Possible values look enclosure

5101 Information *Length 4 t 1 – 255

(integer)

How long ist he following data? 5110 Value len t Value of the additional information 5111

6.11.2 Mounted parts [Field-ID 52xx]

Field Length

[Byte] Format t = Text b = binary Range of Values / Code Comment Field-ID *Kind of use 2 t 0, 1 (integer) 0 = Dismantling 1 = Montage 5200

*[Used parts] Parts, which are needed to create the object

(17)

6.12 Step [Field-ID 60xx]

Every Step may occur only one single time per telegram

Field Length

[Byte] Format t = Text b = binary Range of Values / Code Comment Field -ID *#Step 2 t 0 – 99 (integer)

e.g. the number of bolting step 6000 *#Type of step 4 t 0 – 9999

(integer)

Kind of step, e. g. initial tight of a screw

possible values look enclosure 6005 *Number of step-global settings 2 t 0 – 99

(integer)

Number of the following setting blocks, e. g.

for details for a fastening process 6010 Per setting block +[settings]

*Number of marks 4 t 1 – 200

(integer)

Number of the following mark blocks, number

(18)

6.13 Settings [Field-ID 65xx]

This information can be used e. g. to indicate the tightening process at the fastening process, e. g. “torque

controlled, angle monitored”. To transfer settings in several parts (e. g. “Control: torque” and “Monitoring: torque

angle”), a definition about “mark tagging” (e. g. fastening process) and parameter (e. g. monitoring).

Every mark may occur only one single time.

Field Length

Range of Values /

*Type of setting mark tagging 2 t 0, 1

(integer)

0 = IPM standard mark tagging

1 = user-specific mark tagging

6500 If type of setting

mark tagging = 0 *setting mark tagging 18 t Possible values look enclosure 6501 If type of setting

mark tagging = 1 *[mark taggingUser-specific ] User-specific mark tagging *Data type of the setting value 2 t 0, 1

(integer)

0 = Numeric (float)

1 = Text

6510 If data type = 0 Num. Value 16 t float Numeric setting value 6511 Falls Datentyp =

1

*Length 4 t 0 – 255

(integer)

Length of the text setting value

6512

Text value len t

_{Text setting value}

6513

*Number of setting parameter 2 t 0 – 99

(integer)

6520 Per parameter +[setting

parameter]

6.13.1 Setting parameter [Field-ID 66xx]

Every parameter tagging may occur only one single time per setting block.

Field Lengt h [Byte] Format t = Text b = binary Range of Values /

If setting mark

tagging = 0 *setting parameter tagging

20 t Possible values look enclosure 6600

If setting mark

tagging = 1 *[specific User-parameter tagging]

t

*Data type of the parameter value 2 t 0, 1

(integer)

0 = Numeric (float) 1 = Text

6610 If data type = 0 Num. Value 16 t float e. g. value for lower tolerance or nominal

value 6611

If data type = 1 *Length 4 t 0 – 255

(integer)

Length of the text parameter value 6612

(19)

6.14 Characteristic Data

Each tagging may occur only one single time per level.

The sum of the different mark taggings of all levels may not be bigger than 200.

Field Length

Range of Values /

*Type of mark tagging 2 t 0, 1

(integer)

0 = IPM standard mark tagging 1 = User-specific mark tagging

7000 If type of mark

tagging = 0 *Mark tagging 18 t Possible values look enclosure 7001 If type of mark

tagging = 1 *[specific mark User-tagging]

User-specific mark tagging

Unit *Length 2 t 0 – 10

(integer)

Length of the unit 7010

Value len t Unit; possible values look enclosure 7011 *Length of trace value 2 t 0, 1, 2, 4

(integer)

At trace transfer: either

- Length, factor and algebraic sign, or - Step size and start value indicated

Algebraic sign: - means that trace values are marked with signs

7020 +Factor of trace value 2 t -9 – 99

(integer)

7021

+Algebraic sign of trace value 2 t , -, + 7022

Step size of trace value 16 t float 7023

+start value of trace value 16 t float 7024

*Data type of measured value 2 t 0, 1

(integer)

0 = Numeric (float) 1 = Text

7030 If data type = 0 Num. Value 16 t float Numeric value 7031 If data type = 1 *Length 4 t 0 – 255

(integer)

Length of the measured value in text 7032

Text value len t Measured value in text 7033

Characteristic status 2 t 0 – 99

(integer)

0 =ok 1 = not ok

7040 *Number of parameter 2 t 0 – 99

(integer)

e. g. 3 for lower tolerance, nominal value and upper tolerance

7050 Per parameter +[Parameter]

6.14.1 User-specific mark tagging [Field-ID 71xx]

Field Length

Comment Field

-ID *Mark tagging *Length 2 t 1 – 18

(integer)

Length of the mark tagging 7100

*Value len t Mark tagging 7101

Meaning *Length 4 t 1 – 100

(integer)

Length of the meaning of mark tagging 7110

(20)

6.14.2 Mark example

To send lower tolerance, nominal value and upper tolerance, it has to be entered as number of parameter the value „3“ and immediately following 3 parameter blocks have to be occurred.

Further explanation of the fields length, factor, algebraic sign, step size, start value:

The fields „length“, „factor“, „algebraic sign“, „step size“ and „start value“ only will be considered, if a trace will be transferred.

Trace values will be transferred either by “length”, “factor”, “algebraic sign” or by “step size” and “start value” each filled in with 16 blanks.

In the column “algebraic signs” then it is only possible to enter „+“ or „-“. „“ (blank space) is not permissible in this case.

If the value for the factor is positive, its sign can be left (field factor: +1 is synonymous with 1).

If you work with “step size” and “start value”, “length” has to be 0, „factor“ has to be  and „algebraic sign“ has to be . “Start value” is the value, to which will be added the “step size” for each trace value at the corresponding trace block.

E. g. if the “start value” is 0 and the “step size” is 2, then the first resulting value is 0, the second 2, the third 4 etc. If the “start value” is 25.5 and the “step size” is 0.5, then the values 25.5, 26.0, 26.5 etc. are resulting.

(21)

6.15 Parameter

Each parameter identifier may occur only once per characteristic block.

Field Length

[Bytes] Format t- text b- binary Range of Values/ Code Comment Field-ID If characteristic

tagging type = 0 *parameter tagging 20 t For possible values see the attachment 7500 If characteristic

tagging type = 0 *[parameterUser-specific ] T *data type of parameter

value 2 t 0(integer), 1

0 ₁

= numeric (float)

= text

7510 if data type = 0 +num. Value 16 t float e.g. value for lower tolerance or nominal

value 7511

if data type = 1 +length 4 t 0 – 255

(integer)

Length of text parameter value 7512

+text value len t Text parameter value 7513

6.15.1 User-specific parameter [Field-ID 76xx]

Field Length

Range of Values /

*type of parameter 2 t 0, 1, 2, 3 (integer) 0 = other 1 = lower tolerance 2 = nominal value 3 = upper tolerance 7600 If type of

parameter = 0 +[parameter User-specific tagging]

6.15.2 User-specific parameter tagging [Field-ID 77xx]

Field Length

Range of Values /

*parameter

tagging *Length 2 t 1(integer) – 20

Length of parameter tagging 7700

*value len t Parameter tagging 7701

Meaning *length 4 t 1 – 100

(integer)

Length of the meaning of parameter tagging 7710

*value len t Meaning of parameter tagging 7711

Example 1: The parameter MI+should be transferred as a numerical value. Then the field identifier is filled with MI+, the data type with 0 and the value e.g. with 17.12.

Example 2: The parameter TEXT (until now it´s not defined) should be transferred as a text. The field identifier has to be

TEXT, the data type 1. Length and value are for example 16 and “Das ist ein Text”.

Because parameter values are not explicitly assigned with a unit, the unit will be the same as for the characteristic in which parameter is defined.

E.g.: If the characteristic identification is MI and the unit Nm, the possible attributive parameters are MA, M-, M+ and MS also in

(22)

6.16 Trace [Field-ID 80xx]

(Mandatory if the field “Trace” field is set in Maintenance Sequence User Data)

A characteristic may only be referred once in a trace; this means that if there is a reference to characteristic 1 in the first trace block, no other trace block is allowed to refer to characteristic 1. It is also not allowed to refer to a characteristic twice in a trace block.

Field Length

Range of Values/

*Number of trace blocks 2 t 0 – 99

(integer)

number of blocks (= steps) 8000 for every trace block *Length of Block (=LB) 6 t 0 – 999999 (integer)

number of trace values for the particular trace block 8010 *Step block 2 T 0 – 99

(integer)

Step to which the trace block belongs 8020 *number of

dimesions (=nD)

4 T 1 – 200

(integer)

Number of in the trace available characteristics (characteristics, which trace value was defined by step size, did not count here)

8030 *Characteristic

Dimension 1 4 t 1(integer) – 200

numbering of the characteristics is defined by the occurence in the telegram (first characteristic: number = 1) 8050 ... *Characteristic Dimension nD 4 t 1(integer) – 200 Trace

Value 1 Value Dim 1

from characteri

stic

b the resulting value is created by combining the integer value contained here and the factor (“Length”, “Factor”, “Algebraic Sign” from the characteristic of this dimension)

... Value Dim nD from characteri stic b ... Trace Value LB Value Dim 1 from characteri stic b ... Value Dim nd from characteri stic b

6.17 Checksum [Field-ID 90xx]

Field Length

Range of Values /

*Checksum 1 b Calculated from the whole telegram (including

(23)

7 Acknowledgement

Every telegram sent by the facility gets acknowledged.

The character code is the value of the telegram that has to be acknowledged.

If there is a failure while handling the telegram (wrong checksum, error in telegram structure …), the value sent for status is representing the type of the error.

7.1 Acknowledge header

Field Length

Comment

* Source 8 t Destination field from telegram header * Destination 8 t Source field from telegram header *Identification 8 t IPM-QUIT identification of the telegram

*Version Major 2 t ₆

_

(integer)

version of the telegram (tagging of version look page 1)

Minor 2 T ₀

_

(integer)

*Character Code 20 t US-ASCII oder

ISO-8859-1

Each other codes depend on the platform on which IPM is installed

*Sequence Number 4 t 0 – 9999

(integer)

respectively AAAA

sequence Number of the telegram this acknowledgement refers to

*Length User Data 8 t 41 –

239

(integer)

Incl. check sum but without acknowledge header

7.2 User Data

Field Length

Range of Values /

Code Comment

*Status 6 t 0 – 999999

(integer)

0

_{> 0 not ok; see table “Table „Acknowledgement error} = ok

codes“” on page 24

*Date 10 t dd.MM.yyyy date of the computer with the IPM Gateway (value read when sending starts)

(

d

= day,

M

= month,

y

= year)

*Time 8 t hh:mm:ss time of the computer with the IPM Gateway (24 hour format)

(value read when sending starts) (

h

= hour,

m

= minute,

s

= second) Error position byte 8 t 0 –

99999999

(integer)

Error position within the telegram (field position in byte, beginning with 0 at source)

Error position

field-ID 4 t 0 – 9999 ID of the field, at which the error occurs error

position text

*Length 2 t 0 – 99

(integer)

length of the error position as text

Value len t error position, e. g. statement which parameter of which characteristic in which step

error value *Length 2 t 0 – 99

(integer)

length of the error value

Value len t e. g. text which cannot changed in a figure *Checksum 1 b Calculated from the whole telegram (including

(24)

8 Life-Telegram

To securely detect a connection abort (e.g. disconnected WLAN-connections) IPM has to send data to the respective client. This is the reason for the „life-telegram“.

This telegram is transmitted every 300 seconds, independent if data were sent in this time. The controller DOESN`T acknowledge this telegram.

The interval for sending Life telegrams doesn’t start immediately after connection establishment. Because the life telegram hasn’t been defined in some older IPM telegram definitions it cannot be expected that every controller can handle it. For that reason IPM will wait for the first telegram. If that telegram contains a telegram version number that defines the life telegram, the interval for sending life telegrams starts.

The station can also transmit this telegram to IPM to check the status of the connection. Again, the telegram is NOT acknowledged.

8.1 Life telegram

Field Bytes

(Length) Format t- text b- binary Range of Values / Code Comment Source 8 t *****IPM Destination 8 t ******** Identification 8 t ****LIFE Value 4 t 0001

9 RFC 1006 communication

It is possible to use the RFC 1006 protocol for sending IPM telegrams.

In that situation the controller which sends data to IPM is the passive partner that means that the controller is listening for an incoming connection call.

To detect closed connections, life telegrams are being sent every 300 seconds, too (see 8.1). The life telegram is NOT acknowledged by the controller.

10 Tables

10.1 Table „Acknowledgement error codes“

Values in the field “text error position”, which stand between “[“and”]”, represent the index of the respective

element, beginning with 1. Values, which stand between simple quotation marks, represent the respective value.

Values in round brackets are only available if required. So

„step[1]“

means the first found step, and

„step[1]:'1'“

the step with the step number 1.

10.1.1 1xxxx: General Telegram error / Sequence Number Errors / Checksum Errors

Error code Meaning Text error position

Field-ID

1 General Telegram error 1 General Telegram error 10xxx Sequence number

10000 Sequence number already received 0130

15xxx Prüfsumme 90xx

(25)

10.1.2 2xxxx: Data in wrong format

Error code Meaning Text error position

Field-ID

201xx Telegramm-Header 01xx

20112 Minor-Version is not an integer 0112

20130 Sequence number is not

AAAA

and not an integer 0130

20140 Length of user data is not an integer 0140

202xx Transfer parameter 02xx

20200 Byte order is not an integer 0200

20210 Length of GUID is not an integer 0210

203xx Component at location 03xx

20300 Length of identification number is not an integer 0300

20310 Length of additional ID is not an integer 0310

20320 Length of object number is not an integer 0320

20330 Length of type is not an integer 0330

20340 Length of variation is not an integer 0340

20350 Length of location is not an integer 0350

20370 Status is not an integer 0370

20390 Number of measurement is not an integer 0390

210xx Measurement data 10xx

21001 Facility type is not an integer result[n] 1001

21005 Date is not in the specified format result[n] 1005

21006 Time is not in the specified format result[n] 1006

21010 Length of AFO is not an integer result[n] 1010

21012 Length of bolting process is not an integer result[n] 1012

21015 Length of AFO text is not an integer result[n] 1015

21017 Length of program number is not an integer result[n] 1017

21020 Number of location data is not an integer result[n] 1020

21025 Length of process is not an integer result[n] 1025

21030 Length of connection number is not an integer result[n] 1030

21032 Length of connection name is not an integer result[n] 1032

21040 Number of tool information is not an integer result[n] 1040

21045 Length of module information group is not an integer result[n] 1045

21050 Length of workman-ID is not an integer result[n] 1050

21055 Trace present is not an integer result[n] 1055

21060 Status is not an integer result[n] 1060

21061 Mode is not an integer result[n] 1061

21062 Additional status is not an integer result[n] 1062

21063 Last step of process reached is not an integer result[n] 1063

21065 Number of worker information is not an integer result[n] 1065

21070 Number of additional information is not an integer result[n] 1070

21075 Number of error / rework messages is not an integer result[n] 1075

21080 Number of install results is not an integer result[n] 1080

21085 Number of steps is not an integer result[n] 1085

215xx Location data 15xx

21500 Length of structure type is not an integer result[n], locInfo[m] 1500

(26)

Field-ID

220xx Tool information 20xx

22000 Main tool is not an integer result[n], toolInfo[m] 2000

22010 Length of sequence number is not an integer result[n], toolInfo[m] 2010

22015 Length of manufacturer is not an integer result[n], toolInfo[m] 2015

22020 Length of model is not an integer result[n], toolInfo[m] 2020

22030 Number of further tool information is not an integer result[n], toolInfo[m] 2030

221xx Further tool information 21xx

22100 Meaning of further tool information is not an integer result[n], toolInfo[m],

addToolInfo[i] 2100

22110 Length of further tool information is not an integer result[n], toolInfo[m],

addToolInfo[i] 2110

225xx Module information group 25xx

22501 Number of module information is not an integer result[n],

modInfoGrp[m]:'modInfoGrp' 2501

226xx Module information 26xx

22600 Information type is not an integer result[n],

modInfoGrp[m]:'modInfoGrp', modInfo[m]

2600

22610 Data type of module information value is not an integer result[n],

modInfoGrp[m]:'modInfoGrp' modInfo[m]

2610

22611 Numeric module information value is not a figure result[n],

2611

22612 Length of text module information value is not an integer result[n],

2612

230xx Worker information 30xx

23000 Length of worker ID is not an integer result[n], wrkInfo[m] 3000

232xx Additional information 32xx

23200 Meaning of further tool information is not an integer result[n], addInfo[m] 3200

23210 Length of additional information is not an integer result[n], addInfo[m] 3210

240xx Error / rework message 40xx

24000 Kind of message is not an integer result[n], err[m] 4000

242xx Error code 42xx

24200 Type of error code is not an integer result[n], err[m] 4200

24210 IPM standard error code is not an integer result[n], err[m] 4210

243xx User-specific error code 43xx

24300 Length of user-specific error code result[n], err[m] 4300

24310 Length of meaning user-specific error code is not an integer result[n], err[m] 4310

245xx Rework message 45xx

24510 Length of job is not an integer result[n], err[m] 4510

246xx Problem discription 46xx

24600 Length of component is not an integer result[n], err[m] 4600

24610 Length of kind of problem is not an integer result[n], err[m] 4610

24630 Number of conditions is not an integer result[n], err[m] 4630

(27)

Field-ID

247xx Location 47xx

24700 Type of location is not an integer result[n], err[m] 4700

24710 X-coordinate is not a figure result[n], err[m] 4710

24711 Y-coordinate is not a figure result[n], err[m] 4711

24712 Z-coordinate is not a figure result[n], err[m] 4712

24720 Length of location text is not an integer result[n], err[m] 4720

250xx Installed parts Probably recursively bottom-up 50xx

25000 Length of object number is not an integer result[n], part[m](,part[i]) 5000

25005 Length of identification number is not integer result[n], part[m](,part[i]) 5005

25010 Length of part code is not integer result[n], part[m](,part[i]) 5010

25015 Length of mark is not integer result[n], part[m](,part[i]) 5015

25020 Length of supplier is not integer result[n], part[m](,part[i]) 5020

25025 Number of parts is not an integer result[n], part[m](,part[i]) 5025

25030 Number of additional information for the installed part is not an

integer result[n], part[m](,part[i]) 5030

25040 Number of mounted parts is not an integer result[n], part[m](,part[i]) 5040

251xx Additional information for the installed part Probably recursively bottom-up 51xx 25100 Length of meanin gof additional information for the installed part

is not an integer result[n], part[m](,part[i]), addPartInfo[j] 5100

25110 Length of additional information for the installed part is not an

integer result[n], part[m](,part[i]) , addPartInfo[j] 5110

252xx Mounted parts Probably recursively bottom-up 52xx

25200 Kind of installing is not an integer result[n], part[m](,part[i]) 5200

260xx Step 60xx

26000 Step is not an integer result[n], step[m] 6000

26005 Type of step is not an integer result[n], step[m]:'step' 6005

26010 Number of step-global settings is not an integer result[n], step[m]:'step' 6010

26020 Number of marks is not an integer result[n], step[m]:'step' 6020

265xx Settings 65xx

26500 Setting characteristic tagging is not an integer result[n], step[m]:' step',

setting[i] 6500

26510 Data type of setting value is not an integer result[n], step[m]:' step',

setting[i] 6510

26511 Numeric setting value is not a figure result[n], step[m]:'step',

setting[i] 6511

26512 Length oft ext setting value is not an integer result[n], step[m]:'step', setting[i]

6512

26520 Number of setting parameter is not an integer result[n], step[m]:'step',

setting[i] 6520

266xx Setting parameter 66xx

26610 Data type of setting parameter value is not an integer result[n], step[m]:'step', setting[i], param[j]

6610

26611 Numeric setting parameter value is not a figure result[n], step[m]:'step',

setting[i] , param[j] 6611

26612 Length of text setting parameter value is not an integer result[n], step[m]:'step',

(28)

Field-ID

270xx Characteristic data 70xx

27000 Type of Characteristic tagging is not an integer result[n], step[m]:'step', val[i] 7000

27010 Length of unit is not an integer result[n], step[m]:'step', val[i] 7010

27020 Length of trace value is not an integer result[n], step[m]:'step',

val[i]:'kennung' 7020

27021 Factor of trace value is not an integer result[n], step[m]:'step',

27023 Step size of trace value is not a figure result[n], step[m]:'step',

27024 Start value of trace value is not a figure result[n], step[m]:'step',

27030 Data type of measured value is not an integer result[n], step[m]:'step', val[i]:'kennung'

7030

27031 Numeric actual value is not a figure result[n], step[m]:'step',

27032 Length of text actual value is not an integer result[n], step[m]:'step',

27040 Status characteristic is not an integer result[n], step[m]:'step',

27050 Number of parameter is not an integer result[n], step[m]:'step', val[i]:'kennung'

7050

271xx User-specific characteristic tagging 71xx

27100 Length of user-specific characteristic tagging is not an integer result[n], step[m]:'step', val[i] 7100

27110 Length of meaning user-specific characteristic tagging ist not an

interger result[n], step[m]:'step', val[i]:'kennung' 7110

275xx Parameter 75xx

27510 Data type of parameter value is not an integer result[n], step[m]:'step',

val[i]:'kennung', param[j] 7510

27511 Numeric parameter value is not a figure result[n], step[m]:'step', val[i]:'kennung', param[j]:'kennung'

7511

27512 Length of text parameter value is not an integer result[n], step[m]:'step', val[i]:'kennung', param[j]:'kennung'

7512

276xx User-specific parameter 76xx

27600 User-specific parameter: type is not an integer result[n], step[m]:'step',

val[i]:'kennung', param[j] 7600

277xx User-specific parameter tagging 77xx

27700 Length of user-specific parameter tagging is not an integer result[n], step[m]:'step', val[i]:'kennung', param[j]

7700

27710 Length of meaning user-specific parameter tagging is not an

integer result[n], step[m]:'step', val[i]:'kennung', param[j]:'kennung'

(29)

Field-ID

280xx Trace 80xx

28000 Number of trace blocks is not an integer result[n] 8000

28010 Length of trace block is not an integer result[n], trcBlock[m] 8010

28020 Step block is not an integer result[n], trcBlock[m] 8020

28030 Number of dimensions is not an integer result[n] 8030

28050 Character of dimension x is not an integer result[n], trcBlock[m], 'step', dim[i]

(30)

10.1.3 3xxxx: Value out of range / Value is invalid

Field-ID

301xx Telegram header 01xx

30112 Minor-Version is out of range 0112

30130 Sequence number is out of range 0130

30140 Length of user data is out of range 0140

302xx Assignment parameter 02xx

30200 Byte order is out of range 0200

30210 Length GUID is out of range 0210

303xx Component at location 03xx

30300 Length of identification number is out of range 0300

30310 Length of additional ID is out of range 0310

30320 Length of object number is out of range 0320

30330 Length of type is out of range 0330

30340 Length of variation is out of range 0340

30350 Length of location is out of range 0350

30370 Status is out of range 0370

30390 Number of measurements is out of range 0390

310xx Measurement data 10xx

31001 Station type is out fo range result[n] 1001

31010 Length of AFO is out of range result[n] 1010

31012 Length of bolting process is out of range result[n] 1012

31015 Length of AFO text is out of range result[n] 1015

31017 Length of program number is out of range result[n] 1017

31020 Number of location information is out of range result[n] 1020

31025 Length of working process is out of range result[n] 1025

31030 Length of connection number is out of range result[n] 1030

31032 Length of connection name is out of range result[n] 1032

31040 Number of tool information is out of range result[n] 1040

31045 Number of module information group is out of range result[n] 1045

31050 Length of component carrier ID is out of range result[n] 1050

31055 Trace present is out of range result[n] 1055

31060 Status is out of range result[n] 1060

31061 Mode is out of range result[n] 1061

31062 Additional status is out of range result[n] 1062

31063 Last step of process reached is out of range result[n] 1063

31065 Number of worker information is out of range result[n] 1065

31070 Number of additional information is out of range result[n] 1070

31075 Number of error / rework messages is out of range result[n] 1075

31080 Number of install results is out of range result[n] 1080

31085 Number of steps is out of range result[n] 1085

315xx Location information 15xx

31500 Length of structure type is out of range result[n], locInfo[m] 1500

(31)

Field-ID

320xx Tool information 20xx

32000 Main tool is out of range result[n], toolInfo[m] 2000

32010 Length of sequence number is out of range result[n], toolInfo[m] 2010

32015 Length of manufacturer is out of range result[n], toolInfo[m] 2015

32020 Length of model is out of range result[n], toolInfo[m] 2020

32030 Number of further tool information is out of range result[n], toolInfo[m] 2030

321xx Further tool information 21xx

32100 Meaning of further tool information is out of range result[n], toolInfo[m],

addToolInfo[i] 2100

32110 Length of further tool information is out of range result[n], toolInfo[m],

addToolInfo[i] 2110

325xx Module information group 25xx

32501 Number of module information is out of range result[n],

modInfoGrp[m]:'modInfoGrp' 2501

326xx Module information 26xx

32600 Type of information is out of range result[n],

2600

32610 Data type module inforamtion value is out of range result[n],

2610

32612 Length of text module information value is out of range result[n]

2612

330xx Worker information 30xx

33000 Length of worker ID is out of range result[n], wrkInfo[m] 3000

332xx Additional information 32xx

33200 Meaning of additional information is out of range result[n], addInfo[m] 3200

33210 Length of additional information is out of range result[n], addInfo[m] 3210

340xx Error / rework message 40xx

34000 Kind of message is out of range result[n], err[m] 4000

342xx Error code 42xx

34200 Type of error code is out of range result[n], err[m] 4200

34210 IPM standard error code is out of range result[n], err[m] 4210

343xx User-specific error code 43xx

34300 Length of user-specific error code is out of range result[n], err[m] 4300

34310 Length of meaning of user-specific error code is out of range result[n], err[m] 4310

345xx Rework message 45xx

34510 Length of job is out of range result[n], err[m] 4510

346xx Problem description 46xx

34600 Length of component is out of range result[n], err[m] 4600

34610 Length of kind of problem is out of range result[n], err[m] 4610

34630 Number of condition is out of range result[n], err[m] 4630