BS ISO/IEC 30118-1:2018
$215.11
Information technology. Open Connectivity Foundation (OCF) Specification – Core specification
Published By | Publication Date | Number of Pages |
BSI | 2018 | 282 |
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.
PDF Catalog
PDF Pages | PDF Title |
---|---|
2 | undefined |
4 | Blank Page |
7 | Blank Page |
20 | 1 Scope 2 Normative references |
23 | 3 Terms, definitions, symbols and abbreviations 3.1 Terms and definitions |
26 | 3.2 Symbols and abbreviations |
27 | 3.3 Conventions 3.4 Data types |
28 | 4 Document conventions and organization |
29 | 5 Architecture 5.1 Overview |
30 | 5.2 Principle |
31 | 5.3 Functional block diagram |
32 | 5.4 Framework 5.5 Example Scenario with roles |
33 | 5.6 Example Scenario: Bridging to Non- OCF ecosystem |
34 | 6 Identification and addressing 6.1 Introduction |
35 | 6.2 Identification 6.2.1 Resource identification and addressing |
36 | 6.3 Namespace: 6.4 Network addressing 7 Resource model 7.1 Introduction |
37 | 7.2 Resource |
38 | 7.3 Property 7.3.1 Introduction |
39 | 7.3.2 Common Properties 7.3.2.1 Introduction |
40 | 7.3.2.2 Property Name and Property Value definitions 7.3.2.3 Resource Type 7.3.2.4 Interface 7.3.2.5 Name 7.3.2.6 Resource Identity 7.4 Resource Type 7.4.1 Introduction |
41 | 7.4.2 Resource Type Property 7.4.3 Resource Type definition |
43 | 7.4.4 Multi-value “rt” Resource 7.5 Device Type |
44 | 7.6 Interface 7.6.1 Introduction 7.6.2 Interface Property |
45 | 7.6.3 Interface methods 7.6.3.1 Overview 7.6.3.2 Baseline Interface 7.6.3.2.1 Overview 7.6.3.2.2 Use of RETRIEVE |
46 | 7.6.3.2.3 Use of UPDATE 7.6.3.3 Link List Interface 7.6.3.3.1 Overview 7.6.3.3.2 Example: ālinks listā Interface |
47 | 7.6.3.4 Batch Interface 7.6.3.4.1 Overview |
49 | 7.6.3.4.2 Use of Query Parameters with Batch 7.6.3.4.3 Examples: Batch Interface |
54 | 7.6.3.5 Actuator Interface |
55 | 7.6.3.6 Sensor Interface |
56 | 7.6.3.7 Read-only Interface 7.6.3.8 Read-write Interface |
57 | 7.7 Resource representation 7.8 Structure 7.8.1 Introduction 7.8.2 Resource Relationships |
58 | 7.8.2.1 Parameters 7.8.2.1.1 āinsā or Link Instance Parameter 7.8.2.1.2 āpā or Policy Parameter |
60 | 7.8.2.1.3 ātypeā or Media Type Parameter 7.8.2.1.4 ābpā or the Batch Interface Parameter |
61 | 7.8.2.1.5 ādiā or Device ID parameter 7.8.2.1.6 āepsā Parmeter |
62 | 7.8.2.2 Formatting 7.8.2.3 List of Links in a Collection 7.8.3 Collections 7.8.3.1 Overview |
64 | 7.8.3.2 Collection Properties |
65 | 7.8.3.3 Default Resource Type 7.9 Third (3rd) party specified extensions |
66 | 8 CRUDN 8.1 Overview |
67 | 8.2 CREATE |
68 | 8.2.1 CREATE request 8.2.2 Processing by the Server 8.2.3 CREATE response 8.3 RETRIEVE |
69 | 8.3.1 RETRIEVE request 8.3.2 Processing by the Server 8.3.3 RETRIEVE response 8.4 UPDATE |
70 | 8.4.1 UPDATE request 8.4.2 Processing by the Server 8.4.3 UPDATE response 8.5 DELETE |
71 | 8.5.1 DELETE request 8.5.2 Processing by the Server 8.5.3 DELETE response 8.6 NOTIFY 8.6.1.1 NOTIFICATION response |
72 | 9 Network and connectivity 9.1 Introduction 9.2 Architecture |
73 | 9.3 IPv6 network layer requirements 9.3.1 Introduction |
74 | 9.3.2 IPv6 node requirements 9.3.2.1 Introduction 9.3.2.2 IP Layer 10 Endpoint 10.1 Endpoint definition |
75 | 10.2 Endpoint information 10.2.1 Introduction 10.2.2 āepā 10.2.3 āpriā |
76 | 10.2.4 Endpoint information in “eps” Parameter 10.3 Endpoint discovery 10.3.1 Introduction 10.3.2 Implicit discovery 10.3.3 Explicit discovery with ā/oic/resā response |
80 | 10.4 CoAP based Endpoint discovery |
81 | 11 Functional interactions 11.1 Introduction 11.2 Onboarding, Provisioning and Configuration |
83 | 11.3 Resource discovery 11.3.1 Introduction 11.3.2 Resource based discovery: mechanisms 11.3.2.1 Overview |
84 | 11.3.2.2 Direct discovery 11.3.2.3 Indirect discovery of Resources (resource directory based discovery) |
85 | 11.3.2.4 Advertisement Discovery 11.3.3 Resource based discovery: Information publication process |
86 | 11.3.4 Resource based discovery: Finding information |
92 | 11.3.5 Resource discovery using ā/oic/resā |
94 | 11.3.6 Resource directory (RD) based discovery 11.3.6.1 Introduction 11.3.6.1.1 Indirect discovery for lookup of the resources |
95 | 11.3.6.1.2 Resource directory |
97 | 11.3.6.2 RD discovery 11.3.6.2.1 Discovering a resource directory |
99 | 11.3.6.2.2 RD selection process 11.3.6.2.2.1 Selection criteria |
100 | 11.3.6.2.2.2 Selection scenarios 11.3.6.3 Resource publish 11.3.6.3.1 Publish resources 11.3.6.3.1.1 Overview |
101 | 11.3.6.3.1.2 Publish: Push resource information |
103 | 11.3.6.3.2 Update resource information 11.3.6.3.3 Delete resource information |
104 | 11.3.6.3.4 Transfer resource information from one RD to another 11.3.6.4 Resource exposure 11.3.6.4.1 ā/oic/resā and retrieving of the resources |
108 | 11.4 Notification 11.4.1 Overview 11.4.2 Observe |
109 | 11.4.2.1 RETRIEVE request with observe indication 11.4.2.2 Processing by the Server 11.4.2.3 RETRIEVE response with observe indication |
110 | 11.4.2.4 Resource monitoring by the Server 11.4.2.5 Additional RETRIEVE responses with observe indication 11.4.2.6 Cancelling Observe 11.5 Device management 11.5.1 Overview 11.5.2 Diagnostics and maintenance |
111 | 11.6 Scenes 11.6.1 Introduction 11.6.2 Scenes 11.6.2.1 Introduction |
112 | 11.6.2.2 Scene creation |
113 | 11.6.2.3 Interacting with Scenes |
115 | 11.6.2.4 Summary of Resource Types defined for Scene functionality 11.6.3 Security considerations 11.7 Icons 11.7.1 Overview |
116 | 11.7.2 Resource 11.8 Introspection 11.8.1 Overview |
118 | 11.8.2 Usage of introspection |
119 | 12 Messaging 12.1 Introduction |
120 | 12.2 Mapping of CRUDN to CoAP 12.2.1 Overview 12.2.2 URIs 12.2.3 CoAP method with request and response 12.2.3.1 Overview |
121 | 12.2.3.2 CREATE with POST or PUT 12.2.3.2.1 With POST 12.2.3.2.2 With PUT 12.2.3.3 RETRIEVE with GET |
122 | 12.2.3.4 UPDATE with POST 12.2.3.5 DELETE with DELETE 12.2.4 Content-Format negotiation |
123 | 12.2.5 OCF-Content-Format-Version information 12.2.6 Content-Format policy |
124 | 12.2.7 CRUDN to CoAP response codes 12.2.8 CoAP block transfer |
125 | 12.3 CoAP serialization over TCP 12.3.1.1 Introduction 12.3.1.2 Indication of support 12.3.1.3 Message type and header 12.3.1.4 URI scheme 12.3.1.5 KeepAlive 12.3.1.5.1 Overview 12.3.1.5.2 KeepAlive Mechanism |
126 | 12.4 Payload Encoding in CBOR 13 Security |
128 | Annex A (informative) Operation Examples A.1 Introduction A.2 When at home: From smartphone turn on a single light |
129 | A.3 GroupAction execution A.4 When garage door opens, turn on lights in hall; also notify smartphone A.5 Device management |
131 | Annex B (informative) OCF interaction scenarios and deployment models B.1 OCF interaction scenarios |
132 | B.2 Deployment model |
134 | Annex C (informative) Other Resource Models and OCF Mapping C.1 Multiple resource models C.2 OCF approach for support of multiple resource models |
135 | C.3 Resource model indication C.4 An Example Profile (IPSO profile) C.4.1 Conceptual equivalence |
138 | Annex D (normative) Resource Type definitions D.1 List of Resource Type definitions |
139 | D.2 OCF Collection D.2.1 Introduction D.2.2 Example URI D.2.3 Resource Type D.2.4 RAML Definition |
144 | D.2.5 Property Definition |
145 | D.2.6 CRUDN behavior D.2.7 Referenced JSON schemas D.2.8 oic.oic-link-schema.json |
147 | D.3 Device Configuration D.3.1 Introduction D.3.2 Example URI D.3.3 Resource Type D.3.4 RAML Definition |
152 | D.3.5 Property Definition D.3.6 CRUDN behavior D.4 Platform Configuration D.4.1 Introduction D.4.2 Example URI D.4.3 Resource Type D.4.4 RAML Definition |
155 | D.4.5 Property Definition D.4.6 CRUDN behavior D.5 Device D.5.1 Introduction D.5.2 Wellknown URI D.5.3 Resource Type |
156 | D.5.4 RAML Definition |
158 | D.5.5 Property Definition D.5.6 CRUDN behavior |
159 | D.6 Maintenance D.6.1 Introduction D.6.2 Wellknown URI D.6.3 Resource Type D.6.4 RAML Definition |
161 | D.6.5 Property Definition D.6.6 CRUDN behavior |
162 | D.7 Platform D.7.1 Introduction D.7.2 Wellknown URI D.7.3 Resource Type D.7.4 RAML Definition |
164 | D.7.5 Property Definition |
165 | D.7.6 CRUDN behavior D.8 Ping D.8.1 Introduction D.8.2 Wellknown URI D.8.3 Resource Type D.8.4 RAML Definition |
167 | D.8.5 Property Definition D.8.6 CRUDN behavior D.9 Discoverable Resources Baseline Interface D.9.1 Introduction D.9.2 Wellknown URI D.9.3 Resource Type D.9.4 RAML Definition |
169 | D.9.5 Property Definition |
170 | D.9.6 CRUDN behavior D.10 Discoverable Resources Link List interface D.10.1 Introduction D.10.2 Wellknown URI D.10.3 Resource Type D.10.4 RAML Definition |
171 | D.10.5 Property Definition |
172 | D.10.6 CRUDN behavior |
173 | D.10.7 Referenced JSON schemas D.10.8 oic.oic-link-schema.json |
175 | D.11 Scenes (Top level) D.11.1 Introduction D.11.2 Example URI D.11.3 Resource Type D.11.4 RAML Definition |
177 | D.11.5 Property Definition D.11.6 CRUDN behavior D.12 Scene Collections D.12.1 Introduction |
178 | D.12.2 Example URI D.12.3 Resource Type D.12.4 RAML Definition |
181 | D.12.5 Property Definition |
182 | D.12.6 CRUDN behavior D.13 Scene Member D.13.1 Introduction D.13.2 Example URI D.13.3 Resource Type D.13.4 RAML Definition |
184 | D.13.5 Property Definition D.13.6 CRUDN behavior D.14 Resource directory resource D.14.1 Introduction |
185 | D.14.2 Wellknown URI D.14.3 Resource Type D.14.4 RAML Definition |
190 | D.14.5 Property Definition |
191 | D.14.6 CRUDN behavior D.15 Icon D.15.1 Introduction D.15.2 Example URI D.15.3 Resource Type D.15.4 RAML Definition |
192 | D.15.5 Property Definition D.15.6 CRUDN behavior |
193 | D.16 Introspection Resource D.16.1 Introduction D.16.2 Example URI D.16.3 Resource Type D.16.4 RAML Definition |
194 | D.16.5 Property Definition |
195 | D.16.6 CRUDN behavior |
196 | Annex E (informative) Swagger2.0 definitions E.1 Icon E.1.1 Introduction E.1.2 Example URI E.1.3 Resource Type E.1.4 Swagger2.0 Definition |
198 | E.1.5 Property Definition E.1.6 CRUDN behavior |
199 | E.2 Introspection Resource E.2.1 Introduction E.2.2 Example URI E.2.3 Resource Type E.2.4 Swagger2.0 Definition |
201 | E.2.5 Property Definition |
202 | E.2.6 CRUDN behavior E.3 OCF Collection E.3.1 Introduction E.3.2 Example URI E.3.3 Resource Type E.3.4 Swagger2.0 Definition |
215 | E.3.5 Property Definition |
218 | E.3.6 CRUDN behavior E.4 Platform Configuration E.4.1 Introduction E.4.2 Example URI E.4.3 Resource Type E.4.4 Swagger2.0 Definition |
222 | E.4.5 Property Definition E.4.6 CRUDN behavior E.5 Device Configuration E.5.1 Introduction E.5.2 Example URI E.5.3 Resource Type E.5.4 Swagger2.0 Definition |
228 | E.5.5 Property Definition |
229 | E.5.6 CRUDN behavior E.6 Device E.6.1 Introduction E.6.2 Wellknown URI E.6.3 Resource Type E.6.4 Swagger2.0 Definition |
232 | E.6.5 Property Definition |
233 | E.6.6 CRUDN behavior E.7 Maintenance E.7.1 Introduction E.7.2 Wellknown URI |
234 | E.7.3 Resource Type E.7.4 Swagger2.0 Definition |
236 | E.7.5 Property Definition E.7.6 CRUDN behavior E.8 Platform E.8.1 Introduction E.8.2 Wellknown URI E.8.3 Resource Type |
237 | E.8.4 Swagger2.0 Definition |
240 | E.8.5 Property Definition |
241 | E.8.6 CRUDN behavior E.9 Ping E.9.1 Introduction E.9.2 Wellknown URI E.9.3 Resource Type E.9.4 Swagger2.0 Definition |
243 | E.9.5 Property Definition |
244 | E.9.6 CRUDN behavior E.10 Resource directory resource E.10.1 Introduction E.10.2 Wellknown URI E.10.3 Resource Type E.10.4 Swagger2.0 Definition |
253 | E.10.5 Property Definition |
254 | E.10.6 CRUDN behavior E.11 Discoverable Resources E.11.1 Introduction E.11.2 Wellknown URI E.11.3 Resource Type E.11.4 Swagger2.0 Definition |
261 | E.11.5 Property Definition |
263 | E.11.6 CRUDN behavior E.12 Scenes E.12.1 Introduction E.12.2 Example URI E.12.3 Resource Type E.12.4 Swagger2.0 Definition |
277 | E.12.5 Property Definition |
280 | E.12.6 CRUDN behavior |