ISO/IEC 30118-1:2018
(Main)Information technology — Open Connectivity Foundation (OCF) Specification — Part 1: Core specification
Information technology — Open Connectivity Foundation (OCF) Specification — Part 1: Core specification
The OCF specifications are divided into two sets of documents: — Core Specification documents: The Core Specification documents specify the Framework, i.e., the OCF core architecture, interfaces, protocols and services to enable OCF profiles implementation for Internet of Things (IoT) usages and ecosystems. — Vertical Profiles Specification documents: The Vertical Profiles Specification documents specify the OCF profiles to enable IoT usages for different market segments such as smart home, industrial, healthcare, and automotive. The Application Profiles Specification is built upon the interfaces and network security of the OCF core architecture defined in the Core Specification. This document is the OCF Core specification which specifies the Framework and core architecture.
Technologies de l'information — Spécification de la Fondation pour la connectivité ouverte (Fondation OCF) — Partie 1: Spécification du coeur
General Information
Relations
Standards Content (Sample)
INTERNATIONAL ISO/IEC
STANDARD 30118-1
First edition
2018-11
Information technology — Open
Connectivity Foundation (OCF)
Specification —
Part 1:
Core specification
Technologies de l'information — Spécification de la Fondation pour la
connectivité ouverte (Fondation OCF) —
Partie 1: Spécification du cœur
Reference number
ISO/IEC 30118-1:2018(E)
©
ISO/IEC 2018
---------------------- Page: 1 ----------------------
ISO/IEC 30118-1:2018(E)
COPYRIGHT PROTECTED DOCUMENT
© ISO/IEC 2018
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
Fax: +41 22 749 09 47
Email: copyright@iso.org
Website: www.iso.org
Published in Switzerland
ii © ISO/IEC 2018 – All rights reserved
---------------------- Page: 2 ----------------------
ISO/IEC 30118-1:2018(E)
Foreword
ISO (the International Organization for Standardization) and IEC (the International Electrotechnical
Commission) form the specialized system for worldwide standardization. National bodies that are
members of ISO or IEC participate in the development of International Standards through technical
committees established by the respective organization to deal with particular fields of technical activity.
ISO and IEC technical committees collaborate in fields of mutual interest. Other international
organizations, governmental and non‐governmental, in liaison with ISO and IEC, also take part in the
work. In the field of information technology, ISO and IEC have established a joint technical committee,
ISO/IEC JTC 1.
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 document should be noted (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 and IEC 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. © ISO/IEC 2018 – All rights reserved
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 the Open Connectivity Foundation (OCF) (as the OCF Core Specification
v1.0.0) and drafted in accordance with its editorial rules. It was adopted, under the JTC 1 PAS procedure,
by Joint Technical Committee ISO/IEC JTC 1, Information technology.
A list of all parts in the ISO/IEC 30118 series can be found on the ISO websitte.e
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.
© ISO/IEC 2018 – All rights reserved iii
---------------------- Page: 3 ----------------------
ISO/IEC 30118-1:2018(E)
CONTENTS
1 Scope . 15
2 Normative references . 15
3 Terms, definitions, symbols and abbreviations . 18
3.1 Terms and definitions . 18
3.2 Symbols and abbreviations . 21
3.3 Conventions . 22
3.4 Data types . 22
4 Document conventions and organization . 23
5 Architecture . 24
5.1 Overview . 24
5.2 Principle . 25
5.3 Functional block diagram . 26
5.4 Framework . 27
5.5 Example Scenario with roles . 27
5.6 Example Scenario: Bridging to Non- OCF ecosystem . 28
6 Identification and addressing . 29
6.1 Introduction . 29
6.2 Identification . 30
Resource identification and addressing . 30
6.3 Namespace: . 31
6.4 Network addressing . 31
7 Resource model . 31
7.1 Introduction . 31
7.2 Resource . 32
7.3 Property . 33
Introduction . 33
Common Properties . 34
7.4 Resource Type . 35
Introduction . 35
Resource Type Property . 36
Resource Type definition . 36
Multi-value "rt" Resource . 38
7.5 Device Type . 38
7.6 Interface . 39
Introduction . 39
Interface Property . 39
Interface methods . 40
7.7 Resource representation . 52
7.8 Structure . 52
Introduction . 52
Resource Relationships . 52
3
© ISO/IEC 2018 – All rights reserved
---------------------- Page: 4 ----------------------
ISO/IEC 30118-1:2018(E)
Collections . 57
rd
7.9 Third (3 ) party specified extensions . 60
8 CRUDN . 61
8.1 Overview . 61
8.2 CREATE . 62
CREATE request . 63
Processing by the Server . 63
CREATE response . 63
8.3 RETRIEVE . 63
RETRIEVE request . 64
Processing by the Server . 64
RETRIEVE response . 64
8.4 UPDATE . 64
UPDATE request . 65
Processing by the Server . 65
UPDATE response . 65
8.5 DELETE . 65
DELETE request . 66
Processing by the Server . 66
DELETE response . 66
8.6 NOTIFY . 66
9 Network and connectivity . 67
9.1 Introduction . 67
9.2 Architecture . 67
9.3 IPv6 network layer requirements . 68
Introduction . 68
IPv6 node requirements . 69
10 Endpoint . 69
10.1 Endpoint definition . 69
10.2 Endpoint information . 70
Introduction . 70
“ep” . 70
“pri” . 70
Endpoint information in "eps" Parameter . 71
10.3 Endpoint discovery . 71
Introduction . 71
Implicit discovery . 71
Explicit discovery with “/oic/res” response . 71
10.4 CoAP based Endpoint discovery . 75
11 Functional interactions . 76
11.1 Introduction . 76
11.2 Onboarding, Provisioning and Configuration . 76
11.3 Resource discovery . 78
Introduction . 78
4
© ISO/IEC 2018 – All rights reserved
---------------------- Page: 5 ----------------------
ISO/IEC 30118-1:2018(E)
Resource based discovery: mechanisms . 78
Resource based discovery: Information publication process . 80
Resource based discovery: Finding information . 81
Resource discovery using “/oic/res” . 87
Resource directory (RD) based discovery . 89
11.4 Notification . 103
Overview . 103
Observe . 103
11.5 Device management . 105
Overview . 105
Diagnostics and maintenance . 105
11.6 Scenes . 106
Introduction . 106
Scenes . 106
Security considerations . 110
11.7 Icons . 110
Overview . 110
Resource . 111
11.8 Introspection . 111
Overview . 111
Usage of introspection . 113
12 Messaging . 114
12.1 Introduction . 114
12.2 Mapping of CRUDN to CoAP . 115
Overview . 115
URIs . 115
CoAP method with request and response . 115
Content-Format negotiation . 117
OCF-Content-Format-Version information. 118
Content-Format policy . 118
CRUDN to CoAP response codes . 119
CoAP block transfer . 119
12.3 CoAP serialization over TCP . 120
12.4 Payload Encoding in CBOR . 121
13 Security . 121
Annex A (informative) Operation Examples . 123
A.1 Introduction . 123
A.2 When at home: From smartphone turn on a single light . 123
A.3 GroupAction execution . 124
A.4 When garage door opens, turn on lights in hall; also notify smartphone . 124
A.5 Device management . 124
Annex B (informative) OCF interaction scenarios and deployment models . 126
B.1 OCF interaction scenarios . 126
B.2 Deployment model . 127
5
© ISO/IEC 2018 – All rights reserved
---------------------- Page: 6 ----------------------
ISO/IEC 30118-1:2018(E)
Annex C (informative) Other Resource Models and OCF Mapping . 129
C.1 Multiple resource models . 129
C.2 OCF approach for support of multiple resource models . 129
C.3 Resource model indication . 130
C.4 An Example Profile (IPSO profile) . 130
C.4.1 Conceptual equivalence . 130
Annex D (normative) Resource Type definitions . 133
D.1 List of Resource Type definitions. 133
D.2 OCF Collection . 134
D.2.1 Introduction . 134
D.2.2 Example URI . 134
D.2.3 Resource Type . 134
D.2.4 RAML Definition . 134
D.2.5 Property Definition . 139
D.2.6 CRUDN behavior . 140
D.2.7 Referenced JSON schemas . 140
D.2.8 oic.oic-link-schema.json . 140
D.3 Device Configuration . 142
D.3.1 Introduction . 142
D.3.2 Example URI . 142
D.3.3 Resource Type . 142
D.3.4 RAML Definition . 142
D.3.5 Property Definition . 147
D.3.6 CRUDN behavior . 147
D.4 Platform Configuration . 147
D.4.1 Introduction . 147
D.4.2 Example URI . 147
D.4.3 Resource Type . 147
D.4.4 RAML Definition . 147
D.4.5 Property Definition . 150
D.4.6 CRUDN behavior . 150
D.5 Device . 150
D.5.1 Introduction . 150
D.5.2 Wellknown URI . 150
D.5.3 Resource Type . 150
D.5.4 RAML Definition . 151
D.5.5 Property Definition . 153
D.5.6 CRUDN behavior . 153
D.6 Maintenance . 154
D.6.1 Introduction . 154
D.6.2 Wellknown URI . 154
D.6.3 Resource Type . 154
D.6.4 RAML Definition . 154
D.6.5 Property Definition . 156
6
© ISO/IEC 2018 – All rights reserved
---------------------- Page: 7 ----------------------
ISO/IEC 30118-1:2018(E)
D.6.6 CRUDN behavior . 156
D.7 Platform . 157
D.7.1 Introduction . 157
D.7.2 Wellknown URI . 157
D.7.3 Resource Type . 157
D.7.4 RAML Definition . 157
D.7.5 Property Definition . 159
D.7.6 CRUDN behavior . 160
D.8 Ping . 160
D.8.1 Introduction . 160
D.8.2 Wellknown URI . 160
D.8.3 Resource Type . 160
D.8.4 RAML Definition . 160
D.8.5 Property Definition . 162
D.8.6 CRUDN behavior . 162
D.9 Discoverable Resources Baseline Interface . 162
D.9.1 Introduction . 162
D.9.2 Wellknown URI . 162
D.9.3 Resource Type . 162
D.9.4 RAML Definition . 162
D.9.5 Property Definition . 164
D.9.6 CRUDN behavior . 165
D.10 Discoverable Resources Link List interface . 165
D.10.1 Introduction . 165
D.10.2 Wellknown URI . 165
D.10.3 Resource Type . 165
D.10.4 RAML Definition . 165
D.10.5 Property Definition . 166
D.10.6 CRUDN behavior . 167
D.10.7 Referenced JSON schemas . 168
D.10.8 oic.oic-link-schema.json . 168
D.11 Scenes (Top level) . 170
D.11.1 Introduction . 170
D.11.2 Example URI . 170
D.11.3 Resource Type . 170
D.11.4 RAML Definition . 170
D.11.5 Property Definition . 172
D.11.6 CRUDN behavior . 172
D.12 Scene Collections . 172
D.12.1 Introduction . 172
D.12.2 Example URI . 173
D.12.3 Resource Type . 173
D.12.4 RAML Definition . 173
D.12.5 Property Definition . 176
7
© ISO/IEC 2018 – All rights reserved
---------------------- Page: 8 ----------------------
ISO/IEC 30118-1:2018(E)
D.12.6 CRUDN behavior . 177
D.13 Scene Member . 177
D.13.1 Introduction .
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.