ISO/IEC 30118-4:2021

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

This document specifies the Resources that have been defined by OCF that may be exposed by an OCF Device. Application profile device documents (for example those created for Smart Home or Healthcare) specify device types appropriate to the profile; such documents use Resource Type definitions from this document. This document is built on top of ISO/IEC 30118-1. ISO/IEC 30118-1 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 — Specification de la Fondation pour la connectivité ouverte (Fondation OCF) — Partie 4: Spécification des types de ressources

General Information

• Status: Published
• Publication Date: 17-Oct-2021
• 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: 6060 - International Standard published
• Start Date: 18-Oct-2021
• Due Date: 16-May-2022
• Completion Date: 18-Oct-2021

Relations

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

Overview

ISO/IEC 30118-4:2021 - Information technology - Open Connectivity Foundation (OCF) Specification - Part 4: Resource type specification - defines the OCF Resource Types that can be exposed by an OCF Device. Built on top of ISO/IEC 30118-1 (the OCF Framework), this standard describes the standardized resource models, URIs, interfaces and data schemas used to represent device capabilities across IoT ecosystems. It supports both constrained devices and more capable smart devices, and is used by application profile documents (for example Smart Home or Healthcare) to reference consistent Resource Type definitions.

Key topics and technical requirements

• Resource Type definitions: Canonical resource models (e.g., Air Flow, Battery, Binary Switch, Brightness, Colour RGB, Door, Energy Consumption) with example URIs and intended semantics.
• OpenAPI 2.0 definitions: Machine-readable API specifications for each resource type to enable tooling, validation and interoperability.
• Property definitions and data types: Standardized properties (common and resource-specific), value ranges, and data-type constraints for consistent implementations.
• CRUDN behaviour: Expectations for Create, Read, Update, Delete and Notify operations (CRUDN) and response codes for resource interactions.
• OCF Interfaces and URI conventions: Interface restrictions and baseline model constructs for addressing, accessing and organizing resources.
• Observable and Composite resources: Support for observable resources (notifications, conditional notification) and composition of multiple resource types into higher-level models.
• Document versioning and conventions: Notation, terminology and version control guidance to ensure consistent updates and compatibility.

Applications and who uses this standard

ISO/IEC 30118-4:2021 is intended for:

• IoT device manufacturers implementing OCF-compliant firmware to expose device capabilities reliably.
• Platform and application developers building Smart Home, Healthcare or industrial IoT profiles that reference standard Resource Types.
• Systems integrators and solution architects ensuring interoperability across devices, gateways and cloud services.
• Test labs and certification bodies validating conformance to OCF resource and API specifications. Practical uses include creating interoperable smart lighting, HVAC, door locks, sensors and energy-management solutions with consistent APIs and behaviors.

Related standards

• ISO/IEC 30118-1 - OCF Framework (foundation used by Part 4).
• Other parts of the ISO/IEC 30118 series and the Open Connectivity Foundation specifications for full context on device frameworks, security and profiles.

Keywords: ISO/IEC 30118-4:2021, OCF, Resource type specification, OpenAPI 2.0, CRUDN, IoT interoperability, Smart Home, Healthcare, resource models, constrained devices.

Standards Content (Sample)

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

Contents Page
Foreword . xxix
Introduction . xxx
1 Scope . 1
2 Normative references . 1
3 Terms, definitions and abbreviated terms . 1
3.1 Terms and definitions . 2
3.2 Symbols and abbreviated terms . 2
4 Document conventions and organization . 2
4.1 Conventions . 2
4.2 Notation . 2
5 Baseline model constructs . 3
5.1 URI . 3
5.2 OCF Interfaces . 3
5.2.1 Introduction . 3
5.2.2 Restricting OCF Interface functionality . 4
5.3 OpenAPI specification 2.0 definition . 4
5.4 Property definition . 5
5.4.1 Common Properties . 5
5.4.2 Resource Properties . 5
5.4.3 Basic Resource Schema . 7
5.4.4 CRUDN operation response codes . 7
5.5 Example Resource definitions. 7
5.6 Observable Resource Types . 7
5.6.1 Introduction . 7
5.6.2 Conditional Notification . 8
5.7 Composite Resource Types . 10
5.8 Document version . 11
5.9 Data types . 11
6 Resource Type definitions . 12
6.1 Introduction . 12
6.2 Air Flow . 16
6.2.1 Introduction . 16
6.2.2 Example URI . 16
6.2.3 Resource type . 16
6.2.4 OpenAPI 2.0 definition . 17
6.2.5 Property definition . 19
6.2.6 CRUDN behaviour . 20
6.3 Air Flow Control . 20
6.3.1 Introduction . 20
6.3.2 Example URI . 20
6.3.3 Resource type . 20
6.3.4 OpenAPI 2.0 definition . 20
6.3.5 Property definition . 25
6.3.6 CRUDN behaviour . 26
© ISO/IEC 2021 – All rights reserved iii

6.4 Battery . 26
6.4.1 Introduction . 26
6.4.2 Example URI. 26
6.4.3 Resource type . 26
6.4.4 OpenAPI 2.0 definition. 27
6.4.5 Property definition . 29
6.4.6 CRUDN behaviour . 30
6.5 Binary Switch . 30
6.5.1 Introduction . 30
6.5.2 Example URI. 30
6.5.3 Resource type . 30
6.5.4 OpenAPI 2.0 definition. 30
6.5.5 Property definition . 32
6.5.6 CRUDN behaviour . 32
6.6 Brightness . 33
6.6.1 Introduction . 33
6.6.2 Example URI. 33
6.6.3 Resource type . 33
6.6.4 OpenAPI 2.0 definition. 33
6.6.5 Property definition . 35
6.6.6 CRUDN behaviour . 35
6.7 Colour Chroma . 35
6.7.1 Introduction . 35
6.7.2 Example URI. 36
6.7.3 Resource type . 36
6.7.4 OpenAPI 2.0 definition. 36
6.7.5 Property definition . 38
6.7.6 CRUDN behaviour . 39
6.8 Colour RGB . 39
6.8.1 Introduction . 39
6.8.2 Example URI. 39
6.8.3 Resource type . 39
6.8.4 OpenAPI 2.0 definition. 39
6.8.5 Property definition . 41
6.8.6 CRUDN behaviour . 42
6.9 Dimming . 42
6.9.1 Introduction . 42
6.9.2 Example URI. 42
6.9.3 Resource type . 42
6.9.4 OpenAPI 2.0 definition. 42
6.9.5 Property definition . 44
6.9.6 CRUDN behaviour . 45
6.10 Door . 45
6.10.1 Introduction . 45
6.10.2 Example URI. 45
6.10.3 Resource type . 45
6.10.4 OpenAPI 2.0 definition. 45
6.10.5 Property definition . 47
iv © ISO/IEC 2021 – All rights reserved

6.10.6 CRUDN behaviour . 48
6.11 Energy Consumption . 48
6.11.1 Introduction . 48
6.11.2 Example URI . 48
6.11.3 Resource type . 48
6.11.4 OpenAPI 2.0 definition . 48
6.11.5 Property definition . 50
6.11.6 CRUDN behaviour . 50
6.12 Energy Usage . 51
6.12.1 Introduction . 51
6.12.2 Example URI . 51
6.12.3 Resource type . 51
6.12.4 OpenAPI 2.0 definition . 51
6.12.5 Property definition . 56
6.12.6 CRUDN behaviour . 57
6.13 Humidity . 57
6.13.1 Introduction . 57
6.13.2 Example URI . 57
6.13.3 Resource type . 57
6.13.4 OpenAPI 2.0 definition . 57
6.13.5 Property definition . 59
6.13.6 CRUDN behaviour . 60
6.14 Ice Maker . 60
6.14.1 Introduction . 60
6.14.2 Example URI . 60
6.14.3 Resource type . 60
6.14.4 OpenAPI 2.0 definition . 60
6.14.5 Property definition . 62
6.14.6 CRUDN behaviour . 63
6.15 Lock . 63
6.15.1 Introduction . 63
6.15.2 Example URI . 63
6.15.3 Resource type . 63
6.15.4 OpenAPI 2.0 definition . 63
6.15.5 Property definition . 65
6.15.6 CRUDN behaviour . 66
6.16 Lock Code . 66
6.16.1 Introduction . 66
6.16.2 Example URI . 66
6.16.3 Resource type . 66
6.16.4 OpenAPI 2.0 definition . 66
6.16.5 Property definition . 68
6.16.6 CRUDN behaviour . 68
6.17 Mode . 68
6.17.1 Introduction . 68
6.17.2 Example URI . 68
6.17.3 Resource type . 69
6.17.4 OpenAPI 2.0 definition . 69
© ISO/IEC 2021 – All rights reserved v

6.17.5 Property definition . 71
6.17.6 CRUDN behaviour . 71
6.18 Open Level . 71
6.18.1 Introduction . 71
6.18.2 Example URI. 72
6.18.3 Resource type . 72
6.18.4 OpenAPI 2.0 definition. 72
6.18.5 Property definition . 74
6.18.6 CRUDN behaviour . 74
6.19 Operational State . 75
6.19.1 Introduction . 75
6.19.2 Example URI. 75
6.19.3 Resource type . 75
6.19.4 OpenAPI 2.0 definition. 75
6.19.5 Property definition . 78
6.19.6 CRUDN behaviour . 78
6.20 Ramp Time . 79
6.20.1 Introduction . 79
6.20.2 Example URI. 79
6.20.3 Resource type . 79
6.20.4 OpenAPI 2.0 definition. 79
6.20.5 Property definition . 81
6.20.6 CRUDN behaviour . 81
6.21 Refrigeration . 82
6.21.1 Introduction . 82
6.21.2 Example URI. 82
6.21.3 Resource type . 82
6.21.4 OpenAPI 2.0 definition. 82
6.21.5 Property definition . 85
6.21.6 CRUDN behaviour . 85
6.22 Temperature . 85
6.22.1 Introduction . 85
6.22.2 Example URI. 86
6.22.3 Resource type . 86
6.22.4 OpenAPI 2.0 definition. 86
6.22.5 Property definition . 88
6.22.6 CRUDN behaviour . 89
6.23 Time Period . 89
6.23.1 Introduction . 89
6.23.2 Example URI. 90
6.23.3 Resource type . 90
6.23.4 OpenAPI 2.0 definition. 90
6.23.5 Property definition . 92
6.23.6 CRUDN behaviour . 93
6.24 Activity Count . 93
6.24.1 Introduction . 93
6.24.2 Example URI. 94
6.24.3 Resource type . 94
vi © ISO/IEC 2021 – All rights reserved

6.24.4 OpenAPI 2.0 definition . 94
6.24.5 Property definition . 96
6.24.6 CRUDN behaviour . 96
6.25 Atmospheric Pressure Sensor . 96
6.25.1 Introduction . 96
6.25.2 Example URI . 96
6.25.3 Resource type . 96
6.25.4 OpenAPI 2.0 definition . 97
6.25.5 Property definition . 98
6.25.6 CRUDN behaviour . 99
6.26 Audio Controls . 99
6.26.1 Introduction . 99
6.26.2 Example URI . 99
6.26.3 Resource type . 99
6.26.4 OpenAPI 2.0 definition . 99
6.26.5 Property definition . 101
6.26.6 CRUDN behaviour . 102
6.27 Auto Focus . 102
6.27.1 Introduction . 102
6.27.2 Example URI . 102
6.27.3 Resource type . 102
6.27.4 OpenAPI 2.0 definition . 102
6.27.5 Property definition . 104
6.27.6 CRUDN behaviour . 104
6.28 Automatic Document Feeder . 105
6.28.1 Introduction . 105
6.28.2 Example URI . 105
6.28.3 Resource type . 105
6.28.4 OpenAPI 2.0 definition . 105
6.28.5 Property definition . 107
6.28.6 CRUDN behaviour . 107
6.29 Button Switch . 107
6.29.1 Introduction . 107
6.29.2 Example URI . 107
6.29.3 Resource type . 107
6.29.4 OpenAPI 2.0 definition . 107
6.29.5 Property definition . 109
6.29.6 CRUDN behaviour . 109
6.30 Carbon Dioxide Sensor . 109
6.30.1 Introduction . 109
6.30.2 Example URI . 110
6.30.3 Resource type . 110
6.30.4 OpenAPI 2.0 definition . 110
6.30.5 Property definition . 111
6.30.6 CRUDN behaviour . 112
6.31 Carbon Monoxide Sensor . 112
6.31.1 Introduction . 112
6.31.2 Example URI . 112
© ISO/IEC 2021 – All rights reserved vii

6.31.3 Resource type . 112
6.31.4 OpenAPI 2.0 definition. 113
6.31.5 Property definition . 114
6.31.6 CRUDN behaviour . 115
6.32 Auto White Balance . 115
6.32.1 Introduction . 115
6.32.2 Example URI. 115
6.32.3 Resource type . 115
6.32.4 OpenAPI 2.0 definition. 115
6.32.5 Property definition . 117
6.32.6 CRUDN behaviour . 117
6.33 Colour Saturation . 118
6.33.1 Introduction . 118
6.33.2 Example URI. 118
6.33.3 Resource type . 118
6.33.4 OpenAPI 2.0 definition. 118
6.33.5 Property definition . 120
6.33.6 CRUDN behaviourc . 120
6.34 Contact Sensor . 120
6.34.1 Introduction . 120
6.34.2 Example URI. 120
6.34.3 Resource type . 120
6.34.4 OpenAPI 2.0 definition. 121
6.34.5 Property definition . 122
6.34.6 CRUDN behaviour . 122
6.35 Demand Response Load Control (DRLC) . 123
6.35.1 Introduction . 123
6.35.2 Example URI. 123
6.35.3 Resource type . 123
6.35.4 OpenAPI 2.0 definition. 123
6.35.5 Property definition . 125
6.35.6 CRUDN behaviour . 126
6.36 Energy Overload/Circuit Breaker . 126
6.36.1 Introduction . 126
6.36.2 Example URI. 126
6.36.3 Resource type . 126
6.36.4 OpenAPI 2.0 definition. 126
6.36.5 Property definition . 128
6.36.6 CRUDN behaviour . 128
6.37 Generic Sensor . 128
6.37.1 Introduction . 128
6.37.2 Example URI. 128
6.37.3 Resource type . 129
6.37.4 OpenAPI 2.0 definition. 129
6.37.5 Property definition . 130
6.37.6 CRUDN behaviour . 131
6.38 Glass Break Sensor . 131
6.38.1 Introduction . 131
viii © ISO/IEC 2021 – All rights reserved

6.38.2 Example URI . 131
6.38.3 Resource type . 131
6.38.4 OpenAPI 2.0 definition . 131
6.38.5 Property definition . 133
6.38.6 CRUDN behaviour . 133
6.39 Heart Rate Zone . 133
6.39.1 Introduction . 133
6.39.2 Example URI . 133
6.39.3 Resource type . 133
6.39.4 OpenAPI 2.0 definition . 134
6.39.5 Property definition . 135
6.39.6 CRUDN behaviour . 135
6.40 Illuminance Sensor . 136
6.40.1 Introduction . 136
6.40.2 Example URI . 136
6.40.3 Resource type . 136
6.40.4 OpenAPI 2.0 definition . 136
6.40.5 Property definition . 137
6.40.6 CRUDN behaviour . 138
6.41 Magnetic Field Direction Sensor . 138
6.41.1 Introduction . 138
6.41.2 Example URI . 138
6.41.3 Resource type . 138
6.41.4 OpenAPI 2.0 definition . 138
6.41.5 Property definition . 140
6.41.6 CRUDN behaviour . 140
6.42 Media . 140
6.42.1 Introduction . 140
6.42.2 Example URI . 140
6.42.3 Resource type . 141
6.42.4 OpenAPI 2.0 definition . 141
6.42.5 Property definition . 143
6.42.6 CRUDN behaviour . 143
6.43 Media Source . 144
6.43.1 Introduction . 144
6.43.2 Example URI . 144
6.43.3 Resource type . 144
6.43.4 OpenAPI 2.0 definition . 144
6.43.5 Property definition . 146
6.43.6 CRUDN behaviour . 147
6.44 Media Source List . 147
6.44.1 Introduction . 147
6.44.2 Example URI . 147
6.44.3 Resource type . 147
6.44.4 OpenAPI 2.0 definition . 147
6.44.5 Property definition . 150
6.44.6 CRUDN behaviour .
...