Semantic Definition Format (SDF) for Data and Interactions of Things
draft-ietf-asdf-sdf-01
T2TRG M. Koster, Ed.
Internet-Draft SmartThings
Intended status: Informational C. Bormann, Ed.
Expires: 19 May 2021 Universität Bremen TZI
15 November 2020
Semantic Definition Format (SDF) for Data and Interactions of Things
draft-ietf-asdf-sdf-01
Abstract
The Semantic Definition Format (SDF) is a format for domain experts
to use in the creation and maintenance of data and interaction models
in the Internet of Things. It was created as a common language for
use in the development of the One Data Model liaison organization
(OneDM) definitions. Tools convert this format to database formats
and other serializations as needed.
An SDF specification describes definitions of SDF Objects and their
associated interactions (Events, Actions, Properties), as well as the
Data types for the information exchanged in those interactions.
A JSON format representation of SDF 1.0 was defined in the previous
(-00) version of this document. SDF 1.1 is expected to be defined in
a future version; the present document represents a draft on the way
from 1.0 to 1.1. Hence, this is not an implementation draft.
Contributing
Recent versions of this document are available at its GitHub
repository https://github.com/ietf-wg-asdf/SDF (https://github.com/
ietf-wg-asdf/SDF) -- this also provides an issue tracker as well as a
way to supply "pull requests".
General discussion of this SDF Internet-Draft happens on the mailing
list of the IETF ASDF Working Group, asdf@ietf.org (subscribe at
https://www.ietf.org/mailman/listinfo/asdf
(https://www.ietf.org/mailman/listinfo/asdf)).
The IETF Note Well applies (https://www.ietf.org/about/note-well/
(https://www.ietf.org/about/note-well/)).
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Koster & Bormann Expires 19 May 2021 [Page 1]
Internet-Draft OneDM SDF November 2020
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 19 May 2021.
Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Simplified BSD License text
as described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology and Conventions . . . . . . . . . . . . . . . 3
2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1. Example Definition . . . . . . . . . . . . . . . . . . . 5
2.2. Elements of an SDF model . . . . . . . . . . . . . . . . 7
2.2.1. sdfObject . . . . . . . . . . . . . . . . . . . . . . 8
2.2.2. sdfProperty . . . . . . . . . . . . . . . . . . . . . 8
2.2.3. sdfAction . . . . . . . . . . . . . . . . . . . . . . 9
2.2.4. sdfEvent . . . . . . . . . . . . . . . . . . . . . . 10
2.2.5. sdfData . . . . . . . . . . . . . . . . . . . . . . . 10
2.2.6. sdfThing . . . . . . . . . . . . . . . . . . . . . . 11
2.2.7. sdfProduct . . . . . . . . . . . . . . . . . . . . . 11
3. SDF structure . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1. Information block . . . . . . . . . . . . . . . . . . . . 11
3.2. Namespaces section . . . . . . . . . . . . . . . . . . . 12
3.3. Definitions section . . . . . . . . . . . . . . . . . . . 13
4. Names and namespaces . . . . . . . . . . . . . . . . . . . . 14
4.1. Structure . . . . . . . . . . . . . . . . . . . . . . . . 14
4.2. Contributing global names . . . . . . . . . . . . . . . . 15
4.3. Referencing global names . . . . . . . . . . . . . . . . 15
Show full document text