ISO/IEC PRF 30118-4
(Main)Information technology -- Open Connectivity Foundation (OCF) Specification
Information technology -- Open Connectivity Foundation (OCF) Specification
Technologies de l'information -- Spécification de la Fondation pour la connectivité ouverte (Fondation OCF)
General Information
RELATIONS
Standards Content (sample)
INTERNATIONAL ISO/IEC
STANDARD 30118-4
Second edition
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
PROOF/ÉPREUVE
Reference number
ISO/IEC 30118-4:2021(E)
ISO/IEC 2021
---------------------- Page: 1 ----------------------
ISO/IEC 30118-4:2021(E)
COPYRIGHT PROTECTED DOCUMENT
© 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: +41 22 749 01 11
Email: copyright@iso.org
Website: www.iso.org
Published in Switzerland
ii PROOF/ÉPREUVE © ISO/IEC 2021 – All rights reserved
---------------------- Page: 2 ----------------------
ISO/IEC 30118-4:2021(E)
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---------------------- Page: 3 ----------------------
ISO/IEC 30118-4:2021(E)
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---------------------- Page: 4 ----------------------
ISO/IEC 30118-4:2021(E)
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---------------------- Page: 5 ----------------------
ISO/IEC 30118-4:2021(E)
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---------------------- Page: 6 ----------------------
ISO/IEC 30118-4:2021(E)
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 ..................................................................................
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.