ISO 20242-5:2020

INTERNATIONAL ISO
STANDARD 20242-5
First edition
2020-06
Industrial automation systems and
integration — Service interface for
testing applications —
Part 5:
Application program service interface
Systèmes d'automatisation industrielle et intégration — Interface de
service pour contrôler les applications —
Partie 5: Interface de service des programmes d'application
Reference number
©
ISO 2020
© ISO 2020
All rights reserved. Unless otherwise specified, or required in the context of its implementation, no part of this publication may
be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting
on the internet or an intranet, without prior written permission. Permission can be requested from either ISO at the address
below or ISO’s member body in the country of the requester.
ISO copyright office
CP 401 • Ch. de Blandonnet 8
CH-1214 Vernier, Geneva
Phone: +41 22 749 01 11
Email: copyright@iso.org
Website: www.iso.org
Published in Switzerland
ii © ISO 2020 – All rights reserved

Contents         Page
Foreword . iv
Introduction . v
1 Scope . 1
2 Normative references . 1
3 Terms and definitions . 1
4 Symbols and abbreviated terms . 3
5 Application Program Service Interface . 3
5.1 Introduction . 3
5.2 Parameterization . 5
5.3 Configuration . 6
5.3.1 PID based configuration . 6
5.3.2 Service based and mixed configuration . 6
5.4 Coordinator structure . 7
5.4.1 Workspace. 7
5.4.2 Interface variants . 9
5.5 Details for using APSI . 12
5.5.1 Workspace structure . 12
5.5.2 Callback methods and references . 12
5.5.3 Workspace extension . 13
5.5.4 Workspace transfer . 14
5.5.5 Data monitoring . 14
5.5.6 Data types . 15
5.5.7 Streaming . 16
5.6 Error handling . 18
(normative) Programmer's reference guide — Smart Access Interface . 19
(normative) Programmer's reference guide — Extended Access Interface . 79
(normative) Programmer's reference guide — Full Access Interface . 125
(normative) Reference guide — Enums and status/ident informations . 222
(informative) Sequence diagrams . 235
(informative) Streaming . 243
(informative) Data alignment and byte order . 247
(informative) Testing applications with the ISO 20242 (APSI) series and the
ISO 13209 (OTX) series . 250
(normative) Conformance test methods, criteria and reports . 279
Bibliography . 283
Foreword
ISO (the International Organization for Standardization) is a worldwide federation of national standards
bodies (ISO member bodies). The work of preparing International Standards is normally carried out
through ISO technical committees. Each member body interested in a subject for which a technical
committee has been established has the right to be represented on that committee. International
organizations, governmental and non-governmental, in liaison with ISO, also take part in the work.
ISO collaborates closely with the International Electrotechnical Commission (IEC) on all matters of
electrotechnical standardization.
The procedures used to develop this document and those intended for its further maintenance are
described in the ISO/IEC Directives, Part 1. In particular, the different approval criteria needed for the
different types of ISO documents should be noted. This document was drafted in accordance with the
editorial rules of the ISO/IEC Directives, Part 2 (see www.iso.org/directives).
Attention is drawn to the possibility that some of the elements of this document may be the subject of
patent rights. ISO shall not be held responsible for identifying any or all such patent rights. Details of any
patent rights identified during the development of the document will be in the Introduction and/or on
the ISO list of patent declarations received (see www.iso.org/patents).
Any trade name used in this document is information given for the convenience of users and does not
constitute an endorsement.
For an explanation of the voluntary nature of standards, the meaning of ISO specific terms and
expressions related to conformity assessment, as well as information about ISO's adherence to the World
Trade Organization (WTO) principles in the Technical Barriers to Trade (TBT), see
www.iso.org/iso/foreword.html.
This document was prepared by Technical Committee ISO/TC 184, Automation systems and integration,
Subcommittee SC 5, Interoprability, integration and architectures for enterprise systems and automation
applications.
A list of all parts in the ISO 20242 series can be found on the ISO website.
Any feedback or questions on this document should be directed to the user’s national standards body. A
complete listing of these bodies can be found at www.iso.org/members.html.
iv © ISO 2020 – All rights reserved

Introduction
The motivation for the ISO 20242 series stems from international automotive industries and their
suppliers to facilitate the integration of automation and measurement devices, and other peripheral
components for this purpose, into computer based applications. It defines rules for the construction of
device drivers and their behaviour in the context of an automation and/or measurement application.
The main goal of the ISO 20242 series is to provide users with:
— independence from the computer operating system;
— independence from the device connection technology (device interface/network);
— independence from device suppliers;
— the ability to certify device drivers with connected devices and their behavior in the context of a given
computer platform;
— independence from the technological device development in the future.
The ISO 20242 series will not force the development of new device families or the use of special interface
technologies (networks). It encapsulates a device and its communication interface to make it compatible
with other devices of that kind for a given application.
INTERNATIONAL STANDARD ISO 20242-5:2020(E)

Industrial automation systems and integration — Service
interface for testing applications —
Part 5:
Application program service interface
1 Scope
This document defines the formatting, syntax and semantic rules for describing
— an object oriented interface for using services provided by a coordinator and
— the configuration of virtual devices and the environment for their use.
2 Normative references
The following documents are referred to in the text in such a way that some or all of their content
constitutes requirements of this document. For dated references, only the edition cited applies. For
undated references, the latest edition of the referenced document (including any amendments) applies.
ISO 20242-1, Industrial automation and systems integration — Service interface for testing applications —
Part 1: Overview
ISO 20242-2, Industrial automation and systems integration — Service interface for testing applications —
Part 2: Resource Management Service Interface
ISO 20242-3, Industrial automation and systems integration — Service interface for testing applications —
Part 3: Virtual Device Service Interface
ISO 20242-4, Industrial automation and systems integration — Service interface for testing applications —
Part 4: Device Capability Profile Template
ISO 13209-1, Road vehicles — Open Test sequence eXchange format (OTX) — Part 1: General information
and use cases
ISO 13209-2, Road vehicles — Open Test sequence eXchange format (OTX) — Part 2: Core data model
specification and requirements
3 Terms and definitions
For the purposes of this document, the terms and definitions given in ISO 20242-1, ISO 20242-2,
ISO 20242-3, ISO 20242-4, ISO 13209-1, ISO 13209-2 and the following apply.
ISO and IEC maintain terminological databases for use in standardization at the following addresses:
— ISO Online browsing platform: available at https://www.iso.org/obp
— IEC Electropedia: available at http://www.electropedia.org/
3.1
communication object
existing object which may be accessed with a communication function to read or write a value
[SOURCE: ISO 20242-1:2005, 2.3]
3.2
coordinator
program with a specified interface to handle the access of an application program to one or more device
drivers (3.5) and to manage real-time application aspects, synchronization and events
[SOURCE: ISO 20242-1:2005, 2.4]
3.3
coordinator capability description
text file containing information about the capabilities of coordinators (3.2) in a defined format (i.e.
structure, syntax)
[SOURCE: ISO 20242-4:2011, 3.3]
3.4
coordinator services
services of a coordinator (3.2) for the exchange of data with application programs
3.4
device capability description
text file containing information about the capabilities of virtual devices (3.9) in a defined format (i.e.
structure, syntax)
[SOURCE: ISO 20242-1:2005, 2.5, modified — Note 1 to entry deleted.]
3.5
device driver
software module providing an ISO 20242-specified interface with service functions to call a platform
adapter to access physical devices
[SOURCE: ISO 20242-2:2010, 3.1]
3.6
function object
instance describing one capability of a virtual device (3.9)
[SOURCE: ISO 20242-3:2011, 3.4]
3.7
operation
instance describing one complete procedure
[SOURCE: ISO 20242-3:2011, 3.5]
3.8
parameterization instance description
information about the configuration of a coordinator (3.2) and of virtual devices (3.9)
[SOURCE: ISO 20242-4:2011, 3.8]
2 © ISO 2020 – All rights reserved

3.9
virtual device
representation of one or more physical devices and/or stand-alone software modules that provide an
unambiguous view of the resources of a communication interface
[SOURCE: ISO 20242-3:2011, 3.7]
3.10
workspace
grouping of coordinators (3.2) resources providing an access point for an application
4 Symbols and abbreviated terms
APSI Application Program Service Interface
ASCII American Standard Code for Information Interchange
CCD Coordinator Capability Description
CO Communication Object
DCD Device Capability Description
DCPT Device Capability Profile Template
DSL Domain Specific Language
EAI Extended Access Interface
FAI Full Access Interface
FO Function Object
NIL Null pointer or null reference, does not refer to a valid object
OP Operation
OTX Open Test sequence eXchange
PID Parameterization Instance Description
SAI Smart Access Interface
VD Virtual Device
VDSI Virtual Device Service Interface
XML eXtensible Markup Language (see REC-xml-20040204)
5 Application Program Service Interface
5.1 Introduction
This clause describes a set of services that shall be provided by a coordinator to be used by several
applicat
...