ETSI TS 118 121 V2.0.0 (2016-09)

oneM2M; oneM2M and AllJoyn® Interworking (oneM2M TS-0021 version 2.0.0 Release 2)

DTS/oneM2M-000021

General Information

• Status: Published
• Publication Date: 15-Sep-2016
• Technical Committee: oneM2M - oneM2M
• Current Stage: 12 - Completion
• Due Date: 03-Oct-2016
• Completion Date: 16-Sep-2016

Standards Content (Sample)

ETSI TS 118 121 V2.0.0 (2016-09)






TECHNICAL SPECIFICATION
oneM2M;
®
oneM2M and AllJoyn Interworking
(oneM2M TS-0021 version 2.0.0 Release 2)

---------------------- Page: 1 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 2 ETSI TS 118 121 V2.0.0 (2016-09)



Reference
DTS/oneM2M-000021
Keywords
interworking, IoT, M2M

ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the
print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2016.
All rights reserved.

TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members.
TM
3GPP and LTE™ are Trade Marks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
GSM® and the GSM logo are Trade Marks registered and owned by the GSM Association.
ETSI

---------------------- Page: 2 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 3 ETSI TS 118 121 V2.0.0 (2016-09)
Contents
Intellectual Property Rights . 5
Foreword . 5
1 Scope . 6
2 References . 6
2.1 Normative references . 6
2.2 Informative references . 6
3 Definitions . 7
4 Conventions . 7
5 Architecture Model. 7
5.1 Reference model . 7
5.2 Composition of the IPE . 8
6 Architecture Aspect . 8
6.1 Introduction . 8
6.2 oneM2M resource mapping structure . 9
6.3 AllJoyn IPE registration . 12
6.4 AllJoyn service discovery . 13
6.5 AllJoyn service mapping . 13
6.5.1 AllJoyn service categorization . 13
6.5.2 AllJoyn base service mapping . 13
6.5.3 Other framework service mapping . 14
6.5.4 AllJoyn app-specific service mapping . 14
6.6 AllJoyn access control mapping . 14
7 Interworking Procedures . 14
7.1 Introduction . 14
7.2 IPE initial configuration . 14
7.2.1 Introduction. 14
7.2.2 IPE registration and AllJoyn service discovery . 15
7.2.3 AllJoyn Service Resource creation . 15
7.2.4 Subscription creation . 18
7.2.4.1 Subscription creation by AE/CSE(s) acting as service producers . 18
7.2.4.2 Subscription creation by entities acting as service consumers . 19
7.3 IPE interworking . 20
7.3.1 Introduction. 20
7.3.2 AllJoyn services consumed by AE/CSE(s) . 20
7.3.3 AllJoyn services produced by oneM2M AE/CSE(s) via the IPE . 21
7.3.4 AllJoyn services addition and deletion . 21
Annex A (informative): oneM2M and AllJoyn technical comparison . 23
A.1 API styles . 23
A.2 Service Discovery/Advertisement . 27
Annex B (normative): resource specializations . 28
B.1 Introduction . 28
B.2 Resource Type svcObjWrapper . 28
B.3 Resource Type svcFwWrapper . 29
B.4 Resource Type allJoynApp . 30
B.5 Resource Type allJoynSvcObject . 33
B.6 Resource Type allJoynInterface . 35
ETSI

---------------------- Page: 3 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 4 ETSI TS 118 121 V2.0.0 (2016-09)
B.7 Resource Type allJoynMethod . 37
B.8 Resource Type allJoynMethodCall . 38
B.9 Resource Type allJoynProperty . 40
Annex C (normative): AllJoyn interface mapping to oneM2M resource structure . 43
C.1 Notification service . 43
C.1.1 Notification interface . 43
C.1.2 Notification Producer interface . 44
C.1.3 Dismisser interface . 45
C.2 Control Panel service. 46
C.2.1 Container interface . 46
C.2.2 Property interface . 47
C.2.3 LabelProperty interface . 49
C.2.4 Action interface . 50
C.2.5 NotificationAction interface . 52
C.2.6 Dialog interface . 53
C.2.7 ListProperty interface . 56
C.3 Configuration service . 60
C.3.1 Config interface . 60
Annex D (informative): Bibliography . 63
History . 64

ETSI

---------------------- Page: 4 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 5 ETSI TS 118 121 V2.0.0 (2016-09)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This Technical Specification (TS) has been produced by ETSI Partnership Project oneM2M (oneM2M).
ETSI

---------------------- Page: 5 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 6 ETSI TS 118 121 V2.0.0 (2016-09)
1 Scope
® ®
The present document specifies the oneM2M and AllJoyn interworking technologies that enable AllJoyn
Applications and oneM2M entities produce/consume services.
®
Clause 5 defines the interworking architecture model that describes where the AllJoyn IPE is hosted and how the IPE
is composed with.
®
Clause 6 defines the architecture aspects that mainly describes AllJoyn services to oneM2M resource mapping
®
structure and rules. Furthermore, this explains the IPE registration and AllJoyn service discovery by the IPE.
Clause 7 defines the IPE interworking procedures that consists of the initial setup and the service interworking
procedures.
®
NOTE: AllJoyn is the trade name of a product supplied by the Allseen Alliance, Inc. This information is given
for the convenience of users of the present document and does not constitute an endorsement by ETSI of
the product named. Equivalent products may be used if they can be shown to lead to the same results."
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference/.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are necessary for the application of the present document.
[1] ETSI TS 118 101: "oneM2M; Functional Architecture (oneM2M TS-0001)".
[2] ETSI TS 118 104: "oneM2M; Core Protocol (oneM2M TS-0004)".
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are not necessary for the application of the present document but they assist the
user with regard to a particular subject area.
[i.1] oneM2M Drafting Rules.
NOTE: Available at http://www.onem2m.org/images/files/oneM2M-Drafting-Rules.pdf.
®
[i.2] AllJoyn System Description.
NOTE: Available at http://allseenalliance.org/framework/documentation.
®
[i.3] oneM2M TR-0014: "oneM2M and AllJoyn Interworking".
ETSI

---------------------- Page: 6 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 7 ETSI TS 118 121 V2.0.0 (2016-09)
[i.4] D-Bus Tutorial.
NOTE: Available at https://dbus.freedesktop.org/doc/dbus-tutorial.html.
3 Definitions
For the purposes of the present document, the following terms and definitions apply:
AllJoyn application: application that either produces an AllJoyn service or consumes an AllJoyn service
AllJoyn consumer application: role of an AllJoyn application that consumes AllJoyn services provided by other
AllJoyn applications
AllJoyn producer application: role of an AllJoyn application that produces AllJoyn services consumed by other
AllJoyn applications
AllJoyn service resources: resources created as children of an resource representing an AllJoyn IPE for the
purpose of exposing services between AllJoyn Consumer/Producer Applications and AE/CSE entities
4 Conventions
The key words "Shall", "Shall not", "May", "Need not", "Should", "Should not" in the present document are to be
interpreted as described in the oneM2M Drafting Rules [i.1].
5 Architecture Model
5.1 Reference model
The architecture model followed in the present document is based on the architecture model in annex F of ETSI
TS 118 101 [1] that describes how interworking between oneM2M CSEs and non-oneM2M systems using specialized
Interworking Proxy application Entities (IPE). The present document descibes the AllJoyn IPE that supports the
following reference model.
AE
AllJoyn Application
AllJoyn Protocol
AllJoyn IPE
Mca
Mca
Mcc/Mcc’
CSE CSE
ASN/MN/IN MN/IN

Figure 5.1-1: AllJoyn interworking reference model
This reference model describes how the oneM2M AEs can interwork with AllJoyn applications. By the IPE, AllJoyn
services are exposed as oneM2M resources and stored in a CSE. AEs access the exposed AllJoyn service resources by
the oneM2M APIs.
ETSI

---------------------- Page: 7 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 8 ETSI TS 118 121 V2.0.0 (2016-09)
5.2 Composition of the IPE
The AllJoyn IPE consists of AE and AllJoyn application. To provide the interworking functions to other oneM2M
entities, the IPE registers to a CSE and communicate with other AllJoyn applications using AllJoyn protocols. The IPE
registration is mandatory in oneM2M systems which is not defined in AllJoyn system. AllJoyn discovery and session
establishment are needed for the IPE to communicate with other AllJoyn applications.
In figure 5.2-1, AllJoyn Application on the AllJoyn device and AllJoyn IPE is either AllJoyn Consumer or Producer
Application. Depending on the interworking service scenario, AllJoyn Consumer and/or Producer Application is hosted
on AllJoyn devices and AllJoyn IPEs. For example, when a AllJoyn service is consumed by oneM2M entities, an
AllJoyn devices hosts AllJoyn Producer Application and AllJoyn IPE hosts AllJoyn Consumer Application. In other
case, if a oneM2M entity provides data to be consumed by AllJoyn Consumer Application on an AllJoyn device, then
the AllJoyn IPE hosts AllJoyn Producer Application and the AllJoyn device hosts AllJoyn Consumer Application.
AllJoyn Application
AllJoyn Device
AllJoyn
Protocol
AllJoyn Application
AE
AllJoyn IPE
Mca
CSE

Figure 5.2-1: Composition of the AllJoyn IPE
6 Architecture Aspect
6.1 Introduction
oneM2M and AllJoyn have different architecture aspects (annex A oneM2M and AllJoyn technical comparison). The
present document specifies the interworking functions for those differences in the following aspects:
• oneM2M resource mapping structure;
• AllJoyn IPE registration;
• AllJoyn service discovery;
• AllJoyn service mapping;
• AllJoyn access control mapping.
ETSI

---------------------- Page: 8 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 9 ETSI TS 118 121 V2.0.0 (2016-09)
6.2 oneM2M resource mapping structure
In this clause, the overall resource mapping structure for exposing service between AllJoyn Applications(either
Producer or Consumer) and oneM2M entities is intrtoduced. Since it is difficult to put the resource tree into a single
figure that remains well-readable, the description is split up in multiple figures, In this description, not all specified
attributes of the used resource types and not all possible child resources are depicted to keep the figures readable, For
example resources which may be used to subscribe to some of the depicted resources are not shown.
The resource mapping structure uses some specializations of the resource. Each of this specialization is
detailed in annex B.
The use of each of the resources within the resource mapping structure for consuming or producing services is defined
in detail in clause 7.
Resource Type /
Naming value of labe ls
Specialization
variable
1.n
variable “AllJoyn-IPE”
1 “Iwked-Technology:AllJoyn”,

svcObjects fixed
“Iwked-Entity-Type:SvcObjects
[svcObjWrapper]
1
“Iwked-Technology:AllJoyn”,
svcFrameWorks fixed
“Iwked-Entity-Type:SvcFrameWorks”
[svcFwWrapper]
0.n Not including
variable
“AllJoyn-IPE”

Figure 6.2-1: AllJoyn interworking reseource mapping, part 1
In figure 6.2-1, the first part of the resource mapping structure for AllJoyn interworking is depicted. The
resource of a CSE that is used for connecting to an AllJoyn proximal network is the root of the resource mapping
structure.
The IPE responsible for AllJoyn interworking - see the reference model described in clause 5 - will register with that
CSE and will create an resource which represents the IPE. This resource shall include the string "AllJoyn-
IPE" in the labels attribute. All other relevant AllJoyn interworking resources will be hosted as children or descendants
of this resource. For convenience, this is termed "IPE" in what follows. In figure 6.2-1 the multiplicity of
the resource is defined to be equal to 1.n. Since it is assumed that the CSE represented by the
resource depicted in figure 6.2-1 supports AllJoyn interworking, atr least one respurce representing an AllJyon
IPE shall exist. When the IPE registers with an ASN-CSE or an MN-CSE, the multiplicity shall be 1. This does not
imply that no other application can register with that CSE. It is only meant to define that only one will act as an
IPE for AllJoyn interworking on this CSE. As depicted in figure 6.2-1, other resources - not including the string
"AllJoyn-IPE" in the value of the labels attribute can occur with multiplicity 0.n. On the other hand, when the IPE
registers with IN-CSE, the multiplicity shall be 1.n to allow interworking with multiple different AllJoyn proximal
networks. In figure 6.2-1, and in the following figures two specializations of called "svcObjWrapper"
and "svcFwWrapper" are used. These specializations of do not contain any custom attributes. They
serve only as wrappers for other resources in order to structure the resource tree allowing subscriptions to be made to
that part of the tree. See Annex B for further details on the [svcObjwrapper] and [svcFwWrapper] specialization of
.
Two child resources of the resource representing the IPE are depicted in figure 6.2-1:
• A resource with a fixed name "svcObjects": It serves as a wrapper for hosting resources that are used to expose
services based on the AllJoyn service object model, see also oneM2M TR-0014 [i.3] for details on AllJoyn
service objects. Service Objects in AllJoyn contain one or more AllJoyn interfaces that are used to interact
with services. The resource structure under this [svcObjWrapper] resource called "svcObjects" allows for
direct interaction with AllJoyn interfaces via corresponding resources.
ETSI

---------------------- Page: 9 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 10 ETSI TS 118 121 V2.0.0 (2016-09)
• A resource with a fixed name "svcFrameWorks": It serves as a wrapper for hosting resources that are used to
expose services based on some higher level AllJoyn service frameworks, see also oneM2M TR-0014 [i.3] for
details on AllJoyn service frameworks. AllJoyn service frameworks typically offer a simpler API to
programmers for making use of services compared to operating directly on the AllJoyn interfaces within
AllJoyn service objects. An example for such a service framework is the Lighting Services Framework (LSF)
in AllJoyn. The resource structure under this [svcFwWrapper] resource called "svcFrameWorks" allows use of
functions in selected AllJoyn service frameworks via corresponding resources.
Naming Resource Type value of l abe ls

“Iwked-Technology:AllJoyn”,
svcObjects fixed
“Iwked-Entity-Type:SvcObjects”
[svcObjWrapper]
0.n
“Iwked-Technology:AllJoyn”,
variable
[allJoynApp]
“Iwked-Entity-Type:App”
[allJoynApp]
1
direction
“Iwked-Technology:AllJoyn”,
1.n

“Iwked-Entity-Type:
[allJoynSvcObject] variable
[allJoynSvcObject]
ServiceObject”
1
objectPath
1
enabled
1.n
“Iwked-Technology:AllJoyn”,
[allJoynInterface] variable
“Iwked-Entity-Type:Interface”
[allJoynInterface]

Figure 6.2-2: AllJoyn interworking reseource mapping, part 2
In figure 6.2-2, the second part of the AllJoyn interworking resource mapping is depicted. It describes the structure of
resources hosted under the [svcObjWrapper] resource named "svcObjects".
For each AllJoyn application providing a service that is supposed to be exposed by the IPE via resources under the
"svcObjects" [svcObjWrapper] resource and for all external services that shall be injected into the AllJoyn proximal
network by the IPE, a separate child resource is created which is a [allJoynApp] specialization of . The
details of this [allJoynApp] specialization of are defined in annex B.
The [allJoynApp] specialization of contains a custom attribute direction, which indicates whether the
service is exposed from the AllJoyn side to the oneM2M side (value equal to "allJoynToOneM2m") or vice versa (value
equal to "oneM2mToAllJoyn"). At most one of the [allJoynApp] child resources under the "svcObjects"
[svcObjWrapper] resource can have a direction set to "oneM2mToAllJoyn". For that particular [allJoynApp] - if present
- the IPE acts as a service producer application at the AllJoyn side. It is the IPE's responsibility to create the
[allJoynApp] resources under the "svcObjects" [svcObjWrapper] resource including:
• One [allJoynApp] specialization of resource for each AllJoyn application providing a service
that is supposed to be exposed by the IPE towards oneM2M entities. The name of each of these [allJoynApp]
specialization shall be set to the unique Well-Known-Name (WKN) [i.2] of the corresponding AllJoyn
applicaton. The value for the direction attribute shall be set to "allJoynToOneM2m".
• One [allJoynApp] specialization of resource representing the IPE itself as an AllJoyn
Producer Application hosted by the IPE - in case the IPE supports exposure of services provided by oneM2M
AEs to AllJoyn applications. The name of this [allJoynApp] specialization of shall be set to
the Well-Known-Name (WKN) of the IPE on the AllJoyn bus. The value for the direction attribute shall be set
to "oneM2mToAllJoyn".
Each [allJoynApp] resource will contain one or more [allJoynSvcObject] child resources, which are specializations of
resources representing AllJoyn service objects. Details of the [allJoynSvcObject] specialization of
are defined in Annex B. The [allJoynSvcObject] specialization of contain two custom
attributes:
• objectPath: This is a string equal to the AllJoyn object path for the represented AllJoyn service object.
ETSI

---------------------- Page: 10 ----------------------
oneM2M TS-0021 version 2.0.0 Release 2 11 ETSI TS 118 121 V2.0.0 (2016-09)
• enabled: This is a flag indicating whether the resource respresening the corresponding AllJoyn service object
is currently enabled for service exposure. This is needed since the structure in this resource needs to be created
in multiple steps (creation of children and children of children in this resource structure). During initialization
of the resource structure under a specific [allJoynSvcObject] resrouce, the attribute enabled shall be set to
False as it is not ready for use. Once the initialization is complete and the resource structure can be used for
service interactions, the enabled flag shall be set to True.
The naming of [allJoynSvcObject] is up to the IPE. It would seem logical to derive names from the object path of the
corresponding AllJoyn service object, but due to characters like a slash "/" appeari
...