Sensor Measurement Lists (SenML)
RFC 8428

Document Type RFC - Proposed Standard (August 2018; No errata)
Last updated 2018-08-31
Replaces draft-jennings-core-senml
Stream IETF
Formats plain text pdf html bibtex
Reviews
Stream WG state Submitted to IESG for Publication (wg milestone: Dec 2017 - Media Types for Sens... )
Document shepherd Jaime Jimenez
Shepherd write-up Show (last changed 2017-12-14)
IESG IESG state RFC 8428 (Proposed Standard)
Consensus Boilerplate Yes
Telechat date
Responsible AD Alexey Melnikov
Send notices to Jaime Jimenez <jaime.jimenez@ericsson.com>
IANA IANA review state Version Changed - Review Needed
IANA action state RFC-Ed-Ack
Internet Engineering Task Force (IETF)                       C. Jennings
Request for Comments: 8428                                         Cisco
Category: Standards Track                                      Z. Shelby
ISSN: 2070-1721                                                      ARM
                                                                J. Arkko
                                                              A. Keranen
                                                                Ericsson
                                                              C. Bormann
                                                 Universitaet Bremen TZI
                                                             August 2018

                    Sensor Measurement Lists (SenML)

Abstract

   This specification defines a format for representing simple sensor
   measurements and device parameters in Sensor Measurement Lists
   (SenML).  Representations are defined in JavaScript Object Notation
   (JSON), Concise Binary Object Representation (CBOR), Extensible
   Markup Language (XML), and Efficient XML Interchange (EXI), which
   share the common SenML data model.  A simple sensor, such as a
   temperature sensor, could use one of these media types in protocols
   such as HTTP or the Constrained Application Protocol (CoAP) to
   transport the measurements of the sensor or to be configured.

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in Section 2 of RFC 7841.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   https://www.rfc-editor.org/info/rfc8428.

Jennings, et al.             Standards Track                    [Page 1]
RFC 8428                          SenML                      August 2018

Copyright Notice

   Copyright (c) 2018 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.  Overview  . . . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Requirements and Design Goals . . . . . . . . . . . . . . . .   4
   3.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   6
   4.  SenML Structure and Semantics . . . . . . . . . . . . . . . .   6
     4.1.  Base Fields . . . . . . . . . . . . . . . . . . . . . . .   7
     4.2.  Regular Fields  . . . . . . . . . . . . . . . . . . . . .   7
     4.3.  SenML Labels  . . . . . . . . . . . . . . . . . . . . . .   8
     4.4.  Extensibility . . . . . . . . . . . . . . . . . . . . . .   9
     4.5.  Records and Their Fields  . . . . . . . . . . . . . . . .   9
       4.5.1.  Names . . . . . . . . . . . . . . . . . . . . . . . .   9
       4.5.2.  Units . . . . . . . . . . . . . . . . . . . . . . . .  10
       4.5.3.  Time  . . . . . . . . . . . . . . . . . . . . . . . .  10
       4.5.4.  Values  . . . . . . . . . . . . . . . . . . . . . . .  11
     4.6.  Resolved Records  . . . . . . . . . . . . . . . . . . . .  12
     4.7.  Associating Metadata  . . . . . . . . . . . . . . . . . .  12
     4.8.  Sensor Streaming Measurement Lists (SenSML) . . . . . . .  12
     4.9.  Configuration and Actuation Usage . . . . . . . . . . . .  13
   5.  JSON Representation (application/senml+json)  . . . . . . . .  13
     5.1.  Examples  . . . . . . . . . . . . . . . . . . . . . . . .  14
       5.1.1.  Single Data Point . . . . . . . . . . . . . . . . . .  14
       5.1.2.  Multiple Data Points  . . . . . . . . . . . . . . . .  14
       5.1.3.  Multiple Measurements . . . . . . . . . . . . . . . .  15
       5.1.4.  Resolved Data . . . . . . . . . . . . . . . . . . . .  17
       5.1.5.  Multiple Data Types . . . . . . . . . . . . . . . . .  17
       5.1.6.  Collection of Resources . . . . . . . . . . . . . . .  18
       5.1.7.  Setting an Actuator . . . . . . . . . . . . . . . . .  18
   6.  CBOR Representation (application/senml+cbor)  . . . . . . . .  19
   7.  XML Representation (application/senml+xml)  . . . . . . . . .  21
   8.  EXI Representation (application/senml-exi)  . . . . . . . . .  23

Jennings, et al.             Standards Track                    [Page 2]
Show full document text