ISO/IEC 30118-4:2018

Information technology - Open Connectivity Foundation (OCF) Specification - Part 4: Resource type specification

The OCF Resource Type Specification specifies the Resources that have been defined by OCF that may be exposed by an OCF Device. Application profile device specifications (for example those created for Smart Home or Healthcare) specify device types appropriate to the profile; such specifications use Resource Type definitions from this document. This specification is built on top of the OCF Core Specification. The OCF Core Specification specifies the OCF Framework that enables the implementation of profiles for IoT usages and ecosystems. The OCF Core Framework is scalable to support simple devices (constrained device) and more capable devices (smart device).

Technologies de l'information — Spécification de la Fondation pour la connectivité ouverte (Fondation OCF) — Partie 4: Spécification des types de ressources

General Information

• Status: Withdrawn
• Publication Date: 18-Nov-2018
• Withdrawal Date: 18-Nov-2018
• ICS: 35.200 - Interface and interconnection equipment
• Technical Committee: ISO/IEC JTC 1 - Information technology
• Drafting Committee: ISO/IEC JTC 1 - Information technology
• Current Stage: 9599 - Withdrawal of International Standard
• Start Date: 18-Oct-2021
• Completion Date: 30-Oct-2025

Relations

• Revised: ISO/IEC 30118-4:2021 - Information technology - Open Connectivity Foundation (OCF) Specification - Part 4: Resource type specification
• Effective Date: 18-Apr-2021

Standards Content (Sample)

INTERNATIONAL ISO/IEC
STANDARD 30118-4
First edition
2018-11
Information technology — Open
Connectivity Foundation (OCF)
Specification —
Part 4:
Resource type specification
Technologies de l'information — Spécification de la Fondation pour la
connectivité ouverte (Fondation OCF) —
Partie 4: Spécification des types de ressources
Reference number
©
ISO/IEC 2018
© 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: [phone]
Fax: [phone]
Email: [e-mail]
Website: www.iso.org
Published in Switzerland
ii © ISO/IEC 2018 – All rights reserved

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.
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 Resource Type
Specification, Version 1.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 website.te
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

CONTENTS
1 Scope . 29
2 Normative references . 29
3 Terms, definitions, symbols and abbreviations . 29
3.1 Terms and definitions . 29
3.2 Symbols and abbreviations . 30
3.3 Conventions . 30
4 Document conventions and organization . 30
4.1 Notation . 30
4.2 Data types . 31
5 Baseline Model Constructs . 31
5.1 URI . 31
5.2 Interfaces . 32
5.3 RAML definition . 32
5.4 Property definition . 33
5.4.1 Common Properties . 33
5.4.2 Resource Properties . 33
5.4.3 Basic Resource Schema . 34
5.4.4 CRUDN Operation Response Codes . 34
5.5 Example Resource Definitions . 35
5.6 Observable Resource Types . 38
5.6.1 Conditional Notification . 38
5.7 Composite Resource Types . 41
5.8 Specification Version . 43
6 Resource Type definitions . 43
6.1 Introduction . 43
6.2 Air Flow . 47
6.2.1 Introduction . 47
6.2.2 Example URI . 47
6.2.3 Resource Type . 47
6.2.4 RAML Definition . 47
6.2.5 Property Definition . 51
6.2.6 CRUDN behavior . 52
6.3 Air Flow Control . 52
6.3.1 Introduction . 52
6.3.2 Example URI . 52
6.3.3 Resource Type . 52
6.3.4 RAML Definition . 52
6.3.5 Property Definition . 56
6.3.6 CRUDN behavior . 56
© ISO/IEC 2018 – All rights reserved

6.4 Battery . 56
6.4.1 Introduction . 56
6.4.2 Example URI . 56
6.4.3 Resource Type . 56
6.4.4 RAML Definition . 56
6.4.5 Property Definition . 57
6.4.6 CRUDN behavior . 57
6.5 Binary Switch . 57
6.5.1 Introduction . 57
6.5.2 Example URI . 57
6.5.3 Resource Type . 57
6.5.4 RAML Definition . 57
6.5.5 Property Definition . 59
6.5.6 CRUDN behavior . 60
6.6 Brightness . 60
6.6.1 Introduction . 60
6.6.2 Example URI . 60
6.6.3 Resource Type . 60
6.6.4 RAML Definition . 60
6.6.5 Property Definition . 62
6.6.6 CRUDN behavior . 62
6.7 Colour Chroma . 63
6.7.1 Introduction . 63
6.7.2 Example URI . 63
6.7.3 Resource Type . 63
6.7.4 RAML Definition . 63
6.7.5 Property Definition . 66
6.7.6 CRUDN behavior . 66
6.8 Colour RGB . 66
6.8.1 Introduction . 66
6.8.2 Example URI . 67
6.8.3 Resource Type . 67
6.8.4 RAML Definition . 67
6.8.5 Property Definition . 69
6.8.6 CRUDN behavior . 69
6.9 Dimming . 69
6.9.1 Introduction . 69
6.9.2 Example URI . 69
6.9.3 Resource Type . 69
6.9.4 RAML Definition . 70
6.9.5 Property Definition . 72
6.9.6 CRUDN behavior . 73
6.10 Door . 73
6.10.1 Introduction . 73
© ISO/IEC 2018 – All rights reserved

6.10.2 Example URI . 73
6.10.3 Resource Type . 73
6.10.4 RAML Definition . 73
6.10.5 Property Definition . 75
6.10.6 CRUDN behavior . 76
6.11 Energy Consumption . 76
6.11.1 Introduction . 76
6.11.2 Example URI . 76
6.11.3 Resource Type . 76
6.11.4 RAML Definition . 76
6.11.5 Property Definition . 77
6.11.6 CRUDN behavior . 77
6.12 Energy Usage . 77
6.12.1 Introduction . 77
6.12.2 Example URI . 77
6.12.3 Resource Type . 77
6.12.4 RAML Definition . 77
6.12.5 CRUDN behavior . 79
6.13 Humidity . 79
6.13.1 Introduction . 79
6.13.2 Example URI . 79
6.13.3 Resource Type . 79
6.13.4 RAML Definition . 79
6.13.5 Property Definition . 81
6.13.6 CRUDN behavior . 81
6.14 Ice Maker . 81
6.14.1 Introduction . 81
6.14.2 Example URI . 81
6.14.3 Resource Type . 82
6.14.4 RAML Definition . 82
6.14.5 Property Definition . 84
6.14.6 CRUDN behavior . 85
6.15 Lock . 85
6.15.1 Introduction . 85
6.15.2 Example URI . 85
6.15.3 Resource Type . 85
6.15.4 RAML Definition . 85
6.15.5 Property Definition . 88
6.15.6 CRUDN behavior . 88
6.16 Lock Code . 88
6.16.1 Introduction . 88
6.16.2 Example URI . 88
6.16.3 Resource Type . 88
6.16.4 RAML Definition . 88
© ISO/IEC 2018 – All rights reserved

6.16.5 Property Definition . 90
6.16.6 CRUDN behavior . 90
6.17 Mode . 90
6.17.1 Introduction . 90
6.17.2 Example URI . 90
6.17.3 Resource Type . 91
6.17.4 RAML Definition . 91
6.17.5 Property Definition . 94
6.17.6 CRUDN behavior . 94
6.18 Open Level . 94
6.18.1 Introduction . 94
6.18.2 Example URI . 94
6.18.3 Resource Type . 94
6.18.4 RAML Definition . 94
6.18.5 Property Definition . 97
6.18.6 CRUDN behavior . 98
6.19 Operational State . 98
6.19.1 Introduction . 98
6.19.2 Example URI . 98
6.19.3 Resource Type . 98
6.19.4 RAML Definition . 98
6.19.5 Property Definition . 102
6.19.6 CRUDN behavior . 103
6.20 Ramp Time . 103
6.20.1 Introduction . 103
6.20.2 Example URI . 103
6.20.3 Resource Type . 103
6.20.4 RAML Definition . 103
6.20.5 Property Definition . 106
6.20.6 CRUDN behavior . 106
6.21 Refrigeration. 106
6.21.1 Introduction . 106
6.21.2 Example URI . 106
6.21.3 Resource Type . 106
6.21.4 RAML Definition . 106
6.21.5 Property Definition . 109
6.21.6 CRUDN behavior . 110
6.22 Temperature . 110
6.22.1 Introduction . 110
6.22.2 Example URI . 110
6.22.3 Resource Type . 110
6.22.4 RAML Definition . 110
6.22.5 Property Definition . 114
6.22.6 CRUDN behavior . 114
© ISO/IEC 2018 – All rights reserved

6.23 Time Period . 114
6.23.1 Introduction . 114
6.23.2 Example URI . 114
6.23.3 Resource Type . 114
6.23.4 RAML Definition . 114
6.23.5 Property Definition . 117
6.23.6 CRUDN behavior . 117
6.24 Activity Count . 118
6.24.1 Introduction . 118
6.24.2 Example URI . 118
6.24.3 Resource Type . 118
6.24.4 RAML Definition . 118
6.24.5 Property Definition . 120
6.24.6 CRUDN behavior . 120
6.25 Atmospheric Pressure Sensor . 120
6.25.1 Introduction . 120
6.25.2 Example URI . 120
6.25.3 Resource Type . 120
6.25.4 RAML Definition . 120
6.25.5 Property Definition . 121
6.25.6 CRUDN behavior . 121
6.26 Audio Controls . 121
6.26.1 Introduction . 121
6.26.2 Example URI . 122
6.26.3 Resource Type . 122
6.26.4 RAML Definition . 122
6.26.5 Property Definition . 124
6.26.6 CRUDN behavior . 124
6.27 Auto Focus . 124
6.27.1 Introduction . 124
6.27.2 Example URI . 124
6.27.3 Resource Type . 124
6.27.4 RAML Definition . 124
6.27.5 Property Definition . 127
6.27.6 CRUDN behavior . 127
6.28 Automatic Document Feeder. 127
6.28.1 Introduction . 127
6.28.2 Example URI . 127
6.28.3 Resource Type . 127
6.28.4 RAML Definition . 127
6.28.5 Property Definition . 128
6.28.6 CRUDN behavior . 128
6.29 Button Switch . 128
6.29.1 Introduction . 128
© ISO/IEC 2018 – All rights reserved

6.29.2 Example URI . 128
6.29.3 Resource Type . 129
6.29.4 RAML Definition . 129
6.29.5 Property Definition . 130
6.29.6 CRUDN behavior . 130
6.30 Carbon Dioxide Sensor . 130
6.30.1 Introduction . 130
6.30.2 Example URI . 130
6.30.3 Resource Type . 130
6.30.4 RAML Definition . 130
6.30.5 Property Definition . 131
6.30.6 CRUDN behavior . 131
6.31 Carbon Monoxide Sensor . 131
6.31.1 Introduction . 131
6.31.2 Example URI . 131
6.31.3 Resource Type . 131
6.31.4 RAML Definition . 131
6.31.5 Property Definition . 132
6.31.6 CRUDN behavior . 132
6.32 Auto White Balance . 132
6.32.1 Introduction . 132
6.32.2 Example URI . 132
6.32.3 Resource Type . 132
6.32.4 RAML Definition . 132
6.32.5 Property Definition . 135
6.32.6 CRUDN behavior . 135
6.33 Colour Saturation . 135
6.33.1 Introduction . 135
6.33.2 Example URI . 135
6.33.3 Resource Type . 135
6.33.4 RAML Definition . 135
6.33.5 Property Definition . 137
6.33.6 CRUDN behavior . 137
6.34 Contact Sensor . 137
6.34.1 Introduction . 137
6.34.2 Example URI . 137
6.34.3 Resource Type . 137
6.34.4 RAML Definition . 138
6.34.5 Property Definition . 138
6.34.6 CRUDN behavior . 139
6.35 Demand Response Load Control (DRLC). . 139
6.35.1 Introduction . 139
6.35.2 Example URI . 139
6.35.3 Resource Type . 139
© ISO/IEC 2018 – All rights reserved

6.35.4 RAML Definition . 139
6.35.5 Property Definition . 142
6.35.6 CRUDN behavior . 142
6.36 Energy Overload/Circuit Breaker . 143
6.36.1 Introduction . 143
6.36.2 Example URI . 143
6.36.3 Resource Type . 143
6.36.4 RAML Definition . 143
6.36.5 Property Definition . 144
6.36.6 CRUDN behavior . 144
6.37 Generic Sensor . 144
6.37.1 Introduction . 144
6.37.2 Example URI . 144
6.37.3 Resource Type . 144
6.37.4 RAML Definition . 144
6.37.5 Property Definition . 145
6.37.6 CRUDN behavior . 145
6.38 Glass Break Sensor . 145
6.38.1 Introduction . 145
6.38.2 Example URI . 145
6.38.3 Resource Type . 145
6.38.4 RAML Definition . 145
6.38.5 Property Definition . 146
6.38.6 CRUDN behavior . 146
6.39 Heart Rate Zone . 146
6.39.1 Introduction . 146
6.39.2 Example URI . 147
6.39.3 Resource Type . 147
6.39.4 RAML Definition . 147
6.39.5 Property Definition . 148
6.39.6 CRUDN behavior . 148
6.40 Illuminance Sensor . 148
6.40.1 Introduction . 148
6.40.2 Example URI . 148
6.40.3 Resource Type . 148
6.40.4 RAML Definition . 148
6.40.5 Property Definition . 149
6.40.6 CRUDN behavior . 149
6.41 Magnetic Field Direction Sensor . 149
6.41.1 Introduction . 149
6.41.2 Example URI . 149
6.41.3 Resource Type . 149
6.41.4 RAML Definition . 149
6.41.5 Property Definition . 150
© ISO/IEC 2018 – All rights reserved

6.41.6 CRUDN behavior . 150
6.42 Media . 151
6.42.1 Introduction . 151
6.42.2 Example URI . 151
6.42.3 Resource Type . 151
6.42.4 RAML Definition . 151
6.42.5 Property Definition . 152
6.42.6 CRUDN behavior . 153
6.43 Media Source . 153
6.43.1 Introduction . 153
6.43.2 Example URI . 153
6.43.3 Resource Type . 153
6.43.4 RAML Definition . 153
6.43.5 Property Definition . 156
6.43.6 CRUDN behavior . 156
6.44 Media Source List . 156
6.44.1 Introduction . 156
6.44.2 Example URI . 156
6.44.3 Resource Type . 156
6.44.4 RAML Definition . 156
6.44.5 Property Definition . 159
6.44.6 CRUDN behavior . 159
6.44.7 Referenced JSON schemas . 160
6.45 Media Source Input . 160
6.45.1 Introduction . 160
6.45.2 Example URI . 160
6.45.3 Resource Type . 160
6.45.4 RAML Definition . 160
6.45.5 Property Definition . 163
6.45.6 CRUDN behavior . 163
6.46 Media Source Output . 163
6.46.1 Introduction .
...