OCF SPECIFICATION 2.2.7
Single file download with all specification files in this release (dated November 16, 2023; 44 MB).
Download the OCF 2.2.4 Specification Overview.
Individual files included in above single .zip package:
-
Core Framework
This specifies the mandatory OCF core architecture, core features, resource framework, and protocols to enable OCF implementations for the Internet of Things (IoT). The OCF architecture is based on the Resource Orientated REST architectural style. Additional functional interactions (CRUDN, Messaging, Discovery, Monitoring, and Maintenance) are specified. Other OCF specifications use the models and procedures defined in this document.
Download the OCF Core Specification. -
Core Optional Framework
This specifies optional capabilities of the OCF core architecture that may be realized by OCF implementations for the Internet of Things (IoT). This includes how scenes, rules, and alerts can be realized on an OCF Device.
Download the OCF Core Optional Specification. -
Security
The Security specification defines security objectives, philosophy, resources and mechanism that impacts OCF base layers of the OCF Core specification. The Security specification includes device identity, authentication, provisioning, establishing network credentials, authorization and access control within the OCF Resource-oriented architecture. Security topics also include confidentiality, message integrity, resource persistence protections, and securing exchanges between local and remote devices or hosts.
Download the OCF Security specification. -
Bridging
The Bridging specification specifies a framework for translation between devices in OCF and non-OCF ecosystems. It specifies general requirements for resource discovery, message translation, security, and handling of multiple bridges.
Download the OCF Bridging Specification. -
Resource Type
The Resource Type specification specifies a base resource schema for all OCF resources and a set of resources that are built on this base schema that may be exposed by OCF Devices. The Resource specification uses OpenAPI 2.0 as a specification language for the APIs exposed by the resources and the payload definitions for the resource representations. These resources enable modeling of key Use Cases including: Device Control, Notification, Environment Sensing and Control, Energy Management, and Energy Saving.
Download the OCF Resource Type Specification. -
Device
The Device specification defines how a Device is represented in OCF, and a list of known OCF device types. For the Device Types defined, the document specifies which resources are mandatory to be implemented, noting that all OCF defined resources may optionally be exposed by an OCF Device.
Download the OCF Device Specification. -
Easy Setup
This specification defines functional extensions to the capabilities defined in the OCF Core Specification to meet the requirements Easy Setup of either Wi-Fi on an OCF Device, or eSIM connectivity on an OCF Device. This specification specifies new Resource Types to enable the functionality and any extensions to the existing capabilities defined in the OCF Core Specification.
Download the OCF Easy Setup Specification. -
Device to Cloud Services
This specification defines functional extensions to the capabilities defined in the OCF Core Specification to meet the requirements of a Device connected to an OCF Cloud. This specification specifies new Resource Types to enable the functionality and any extensions to the existing capabilities defined in the OCF Core Specification.
Download the OCF Device to Cloud Services Specification. -
Resource to AllJoyn Interface Mapping
The OCF Resource to AllJoyn Interface Mapping specification provides detailed mapping information to provide equivalency between AllJoyn defined Interfaces and OCF defined Resources. The specification provides mapping for Device Types (AllJoyn to/from OCF), identifies equivalent OCF Resources for both mandatory and optional AllJoyn interfaces and for each interface defines the detailed Property by Property mapping using OCF defined extensions to JSON schema to programmatically define mappings.
Download the OCF Resource to AllJoyn Interface Mapping Specification. -
Resource to BLE Mapping
This document provides detailed mapping information between BLE (Bluetooth Low Energy) and OCF defined Resources.
Download the OCF Resource to BLE Mapping Specification. -
Resource to LWM2M Mapping
The OCF Resource to LWM2M Mapping specification provides detailed mapping information to provide equivalency between LWM2M defined Objects and OCF defined Resources. A LWM2M Bridge is an Asymmetric Client Bridge, therefore this document identifies equivalent OCF Resources for specific LWM2M Objects, and defines the detailed Property by Property mapping using OCF defined extensions to JSON schema to programmatically define the mappings.
Download the OCF Resource to LWM2M Mapping specification.
-
Resource to Matter Cluster Mapping
The OCF Resource to Matter Cluster Mapping specification provides detailed mapping information to provide equivalency between Matter defined Objects and OCF defined Resources. The overall goal is to represent Bridged Matter Servers to OCF Clients as if they were native OCF Servers in the local network or cloud environment.
Download the OCF Resource to Matter Cluster Mapping specification.
-
Resource Type OMA Optional
This document specifies optional OMA resource types that can be used in an OCF Device.
Download the OCF Resource Type OMA Optional Specification. -
Resource to OneM2M Module Class Mapping
The OCF Resource to OneM2M Module Class Mapping specification provides detailed mapping information to provide equivalency between oneM2M defined Module Classes and OCF defined Resources. A oneM2M Bridge is Asymmetric Client Bridge, therefore this document provides unidirectional mapping for Device Types, identifies equivalent OCF Resources for specific oneM2M Module Classes, and defines the detailed Property by Property mapping using OCF defined extensions to JSON schema to programmatically define the mappings.
Download the OCF Resource to OneM2M Module Class Mapping Specification. -
Resource to UPlus Mapping
This document provides detailed mapping information between UPlus (U+) and OCF defined Resources.
Download the OCF Resource to UPlus Mapping Specification. -
Resource to Zigbee Cluster Mapping
This document provides detailed mapping information between Zigbee defined Clusters and OCF defined Resources.
Download the OCF Resource to Zigbee Cluster Mapping Specification -
Resource to Z-Wave Mapping
This document provides detailed mapping information between Z-Wave and OCF defined Resources.
Download the OCF Resource to Z-Wave Mapping Specification -
Resource to EnOcean Mapping
This document provides detailed mapping information between EnOcean and OCF defined Resources.
Download the OCF Resource to Z-Wave Mapping Specification -
Onboarding Tool
Download the OCF Onboarding Tool Specification
-
Cloud Security
Download the OCF Cloud Security Specification
-
OCF Cloud API for Cloud Services
The OCF Cloud API for Cloud Services provides well-defined APIs exist for device information retrieval (and update) and event subscription between two OCF Cloud instances. The APIs are designed to be agnostic of the data models; hence all existing and future data models published by OCF can be used. The data models describe payloads for the RESTful verbs and when originating from outside of a cloud (for example, when retrieving an end device's information), are passed through unaltered.
Download the OCF Cloud API for Cloud Services Specification.
Reference Documents
-
OCF Certificate Policy
This Certificate Policy comprises the policy framework for the PKI and is consistent with the Internet X.509 PKI Certificate Policy and Certification Practices Framework [RFC 3647]. It governs the operations of the PKI components by all individuals and entities within the PKI (collectively, “PKI Participants”). It provides the minimum requirements that PKI Participants are required to meet when issuing and managing Certification Authorities (CAs), digital certificates, and private keys. In addition, it informs potential Relying Parties about what they need to know prior to relying on issued certificates.
Download the OCF Certificate Policy.
Draft specifications
Specifications in IPR review may be found on the Draft Specifications page here.
Specification Archive
OCF 2.2.6
OCF 2.2.6 Specifications - single file download (English) (20 MB)
OCF 2.2.5
OCF 2.2.5 Specifications - single file download (English) (20 MB)
OCF 2.2.4
OCF 2.2.4 Specifications - single file download (English) (30 MB)
OCF 2.2.3
OCF 2.2.3 Specifications - single file download (English) (20 MB)
OCF 2.2.2
OCF 2.2.2 Specifications - single file download (English) (18 MB)
Download the OCF 2.2.2 Specification Overview presentation here.
OCF 2.2.1
OCF 2.2.1 Specifications - single file download (English) (18 MB)
OCF 2.2.0
OCF 2.2.0 Specifications - single file download (English) (17.5 MB)
OCF 2.1.1
OCF 2.1.1 Specification Introduction and Overview deck
OCF 2.1.1 Specifications - single file download (English) (14.5 MB)
OCF Core Specification (2.1.1)
OCF Core Optional Specification (2.1.1)
OCF Security Specification (2.1.1)
OCF Resource Type Specification (2.1.1)
OCF Device Specification (2.1.1)
OCF Bridging Specification (2.1.1)
OCF Wi-Fi Easy Setup Specification (Core Specification Extension) (2.1.1)
OCF Device to Cloud Services Specification (2.1.1)
OCF Resource to AllJoyn Interface Mapping Specification (2.1.1)
OCF Resource to BLE Mapping Specification (2.1.1)
OCF Resource to OneM2M Module Class Mapping Specification (2.1.1)
OCF Resource to Zigbee Cluster Mapping Specification (2.1.1)
OCF Resource to Z-Wave Mapping Specification (2.1.1)
OCF Onboarding Tool Specification (2.1.1)
OCF Cloud Security Specification (2.1.1)
OCF 2.1.0
OCF 2.1.0 Specification Introduction and Overview deck
OCF 2.1.0 Specifications - single file download (English) (14.5 MB).
OCF Core Specification (2.1.0, English, Simplified Chinese)
OCF Core Optional Specification (2.1.0)
OCF Security Specification (2.1.0)
OCF Resource Type Specification (2.1.0)
OCF Device Specification (2.1.0)
OCF Bridging Specification (2.1.0)
OCF Wi-Fi Easy Setup Specification (Core Specification Extension) (2.1.0)
OCF Device to Cloud Services Specification (2.1.0)
OCF Resource to AllJoyn Interface Mapping Specification (2.1.0)
OCF Resource to BLE Mapping Specification (2.1.0)
OCF Resource to OneM2M Module Class Mapping Specification (2.1.0)
OCF Resource to Zigbee Cluster Mapping Specification (2.1.0)
OCF Resource to Z-Wave Mapping Specification (2.1.0)
OCF Onboarding Tool Specification (2.1.0)
OCF Cloud Security Specification (2.1.0)
OCF 2.0.5
OCF 2.0.5 Specification Introduction and Overview deck
OCF 2.0.5 Specifications - single file download (English) (12.8 MB).
OCF Core Specification (2.0.5)
OCF Core Optional Specification (2.0.5)
OCF Security Specification (2.0.5)
OCF Resource Type Specification (2.0.5)
OCF Device Specification (2.0.5)
OCF Bridging Specification (2.0.5)
OCF Wi-Fi Easy Setup Specification (Core Specification Extension) (2.0.5)
OCF Device to Cloud Services Specification (2.0.5)
OCF Resource to AllJoyn Interface Mapping Specification (2.0.5)
OCF Resource to OneM2M Module Class Mapping Specification (2.0.5)
OCF Resource to Zigbee Cluster Mapping Specification (2.0.5)
OCF Onboarding Tool Specification (2.0.5)
OCF Cloud Security Specification (2.0.5)
OCF 2.0.4
OCF 2.0.4 Specification Introduction and Overview deck
OCF 2.0.4 Specifications - single file download (English) (10.6 MB).
OCF Core Specification (2.0.4)
OCF Security Specification (2.0.4)
OCF Resource Type Specification (2.0.4)
OCF Device Specification (2.0.4)
OCF Bridging Specification (2.0.4)
OCF Wi-Fi Easy Setup Specification (Core Specification Extension) (2.0.4)
OCF Cloud Specification (Core Specification Extension) (2.0.4)
OCF Resource to AllJoyn Interface Mapping Specification (2.0.4)
OCF Resource to OneM2M Module Class Mapping Specification (2.0.4)
OCF 2.0.3
OCF 2.0.3 Specification Introduction and Overview deck
OCF 2.0.3 Specifications - single file download (English) (10.6 MB).
OCF Core Specification (2.0.3)
OCF Security Specification (2.0.3)
OCF Resource Type Specification (2.0.3)
OCF Device Specification (2.0.3)
OCF Wi-Fi Easy Setup Specification (Core Specification Extension) (2.0.3)
OCF Cloud Specification (Core Specification Extension) (2.0.3)
OCF Resource to AllJoyn Interface Mapping Specification (2.0.3)
OCF Resource to OneM2M Module Class Mapping Specification (2.0.3)
OCF 2.0.2
OCF 2.0.2 Specification Introduction and Overview deck
OCF 2.0.2 Specifications - single file download (English) (10.6 MB).
OCF Core Specification (2.0.2)
OCF Security Specification (2.0.2)
OCF Resource Type Specification (2.0.2)
OCF Device Specification (2.0.2)
OCF Wi-Fi Easy Setup Specification (Core Specification Extension) (2.0.2)
OCF Cloud Specification (Core Specification Extension) (2.0.2)
OCF Resource to AllJoyn Interface Mapping Specification (2.0.2)
OCF Resource to OneM2M Module Class Mapping Specification (2.0.2)
OCF 2.0.1
OCF 2.0.1 Specification Introduction and Overview deck
OCF 2.0.1 Specifications - single file download (English) (10.6 MB).
OCF Core Specification (2.0.1)
OCF Security Specification (2.0.1)
OCF Resource Type Specification (2.0.1)
OCF Device Specification (2.0.1)
OCF Wi-Fi Easy Setup Specification (Core Specification Extension) (2.0.1)
OCF Cloud Specification (Core Specification Extension) (2.0.1)
OCF 2.0
OCF 2.0 Specification Introduction and Overview Presentation
OCF 2.0 Specifications - single file download (English) (15 MB).
OCF Core Specification (2.0)
OCF Security Specification (2.0)
OCF Resource Type Specification (2.0)
OCF Device Specification (2.0)
OCF Wi-Fi Easy Setup Specification (Core Specification Extension) (2.0)
OCF Cloud Specification (Core Specification Extension) (2.0)
OCF 1.3
OCF 1.3 Specification Introduction and Overview Presentation
OCF 1.3 Specifications - single file download (English, Korean) (15 MB).
OCF Core Specification (1.3), (1.3.1)
OCF Security Specification (1.3), (1.3.1)
OCF Bridging Specification (1.3)
OCF Resource Type Specification (1.3.1)
OCF Device Specification (1.3)
OCF Wi-Fi Easy Setup Specification (Core Specification Extension) (1.3), (1.3.1)
OCF 1.0
Read the OCF 1.0 Specification Introduction and Overview (English, Japanese) for more background.
OCF 1.0 Specifications (English, Korean) (dated June 28, 2017; 13.5 MB).
OIC 1.1
OIC Core Specifications ( 1.1.2, 1.1.1, 1.1.0)
OIC Security Specifications ( 1.1.1, 1.1.0)
Certification
Please visit the members-only website for more plugfest event details and access to the certification-related documents.
IoTivity Open Source Code
Visit the IoTivity web page for the open source code: https://www.iotivity.org/
Exclusions
None.
Supplemental Spec Resources
Published Specification Legal Disclaimer
Copyright © 2016-2019 Open Connectivity Foundation, Inc. All rights reserved.
The OCF logo is a trademark and/or service mark of Open Connectivity Foundation, Inc. in the United States or other countries. Other names and brands may be claimed as the property of others.
USE OF THE INFORMATION CONTAINED HEREIN SHALL BE GOVERNED SOLELY BY THE TERMS AND CONDITIONS OF THE OPEN CONNECTIVITY FOUNDATION, INC. INTELLECTUAL PROPERTY RIGHTS POLICY. THE DOCUMENT AND INFORMATION CONTAINED HEREIN IS NOT, IN ITSELF, A LICENSE, EITHER EXPRESSLY OR IMPLIEDLY, TO ANY INTELLECTUAL PROPERTY OWNED OR CONTROLLED BY ANY MEMBER OF THE OPEN CONNECTIVITY FOUNDATION, INC. OR OF ANY OTHER AUTHORS OR DEVELOPERS OF THIS SPECIFICATION OR OTHER DOCUMENT. THE INFORMATION CONTAINED HEREIN IS PROVIDED ON AN "AS IS" BASIS, AND TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE OPEN CONNECTIVITY FOUNDATION, INC., AS WELL AS THE AUTHORS AND DEVELOPERS OF THIS SPECIFICATION OR OTHER DOCUMENT HEREBY DISCLAIM ALL OTHER WARRANTIES AND CONDITIONS, EITHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES, DUTIES OR CONDITIONS OF MERCHANTABILITY, OF FITNESS FOR A PARTICULAR PURPOSE, OF ACCURACY OR COMPLETENESS, OF RESULTS, OF WORKMANLIKE EFFORT, OF LACK OF VIRUSES, OF LACK OF NEGLIGENCE OR NON-INFRINGEMENT.