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

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






TECHNICAL SPECIFICATION
oneM2M;
Home Appliances Information Model and Mapping
(oneM2M TS-0023 version 2.0.0 Release 2)

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



Reference
DTS/oneM2M-000023
Keywords
information model, IoT, M2M

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

Tel.: +33 4 92 94 42 00  Fax: +33 4 93 65 47 16

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-0023 version 2.0.0 Release 2 3 ETSI TS 118 123 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 Home Appliance Information Model . 7
5.1 Introduction . 7
5.2 Design Principle of the Home Appliance Information Model . 7
5.2.1 Basic design principle of information modelling . 7
5.2.2 Description rules for Module Classes and Device models . 8
5.3 ModuleClasses . 9
5.3.1 alarmSpeaker . 9
5.3.2 audioVideoInput . 9
5.3.3 audioVolume. 9
5.3.4 battery . 10
5.3.5 binarySwitch . 10
5.3.6 bioElectricalImpedance Anal ysis . 10
5.3.7 boiler . 11
5.3.8 brightness . 11
5.3.9 clock . 11
5.3.10 colour . 11
5.3.11 colourSaturation . 12
5.3.12 doorStatus . 12
5.3.13 electricVehicleConnector . 12
5.3.14 energyConsumption . 13
5.3.15 energyGeneration . 13
5.3.16 faultDetection . 13
5.3.17 height . 14
5.3.18 hotWaterSupply . 14
5.3.19 keypad . 14
5.3.20 motionSensor . 14
5.3.21 oximeter . 15
5.3.22 powerSave. 15
5.3.23 pushButton . 15
5.3.24 recorder . 15
5.3.25 refrigeration . 16
5.3.26 relativeHumidity . 16
5.3.27 rinseLevel . 16
5.3.28 runMode . 16
5.3.29 signalStrength . 17
5.3.30 smokeSensor . 17
5.3.31 spinLevel . 17
5.3.32 televisionChannel . 17
5.3.33 temperature . 18
5.3.34 temperatureAlarm . 18
5.3.35 timer . 18
5.3.36 turbo . 19
5.3.37 waterFlow . 20
5.3.38 waterLevel . 20
5.3.39 waterSensor. 20
5.3.40 weight . 20
ETSI

---------------------- Page: 3 ----------------------
oneM2M TS-0023 version 2.0.0 Release 2 4 ETSI TS 118 123 V2.0.0 (2016-09)
5.3.41 wind . 20
5.4 Device models . 21
5.5 Enumeration type definitions . 25
5.5.1 hd:deviceType . 25
5.5.2 hd:supportedInputSources . 25
5.5.3 hd:liquidLevel . 26
5.5.4 hd:spinLevelStrength . 26
5.5.5 hd:doorState . 26
5.5.6 hd:tone . 26
5.5.7 hd:supportedModes . 27
5.5.8 hd:alertColourCode . 27
5.5.9 hd:waterFlowStrength . 27
5.5.10 hd:windStrength . 28
5.6 Universal and Common Properties for Device models . 28
6 The Principle of Resource Mapping for Home Appliance Information Model. 29
6.1 Introduction . 29
6.2 The Resource Mapping Rules . 29
6.2.1 Introduction. 29
6.2.2 Resource mapping for Device model . 29
6.2.3 Resource mapping for ModuleClass . 30
6.2.4 Resource mapping for Action . 30
6.2.5 Resource mapping for Property . 30
6.2.6 Resource mapping for DataPoint . 30
6.3 Short names . 31
6.3.1 Introduction. 31
6.3.2 Resource types . 31
6.3.3 Resource attributes for properties and data points . 32
6.4 containerDefinition values. 35
6.4.1 Introduction. 35
6.4.2 Device models . 35
6.4.3 ModuleClasses . 35
6.4.4 Actions . 36
6.5 XSD definitions . 36
6.5.1 Introduction. 36
6.5.2 XSD definitions for Device models . 37
6.5.3 XSD definitions for ModuleClass . 37
6.5.4 XSD definitions for Action . 38
7 Mapping with Other Information Models from External Organizations . 38
8 Ontology for the Home Appliance Information Model aligned with oneM2M Base Ontology . 39
Annex A (informative): Resource Mapping Examples . 40
A.1 Introduction . 40
A.2 Example for Device model ‘deviceAirConditioner' . 40
A.3 Example of ModuleClass 'binarySwitch' . 43
A.4 Example of Action 'toggle' . 44
History . 46

ETSI

---------------------- Page: 4 ----------------------
oneM2M TS-0023 version 2.0.0 Release 2 5 ETSI TS 118 123 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-0023 version 2.0.0 Release 2 6 ETSI TS 118 123 V2.0.0 (2016-09)
1 Scope
The present document describes the oneM2M defined information model for home appliances, including the description
of how it is mapped with other information models from external organizations. It also explains the ontology for the
home domain information model.
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] Home Gateway Initiative Smart Device Template.
NOTE: Available at
https://github.com/Homegateway/SmartDeviceTemplate/tree/7c890b69d9764e341ef1768c5a0e7d53a47cf
f5c.
[2] Java coding rule.
NOTE: Available at http://www.oracle.com/technetwork/java/codeconventions-135099.html.
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.
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] oneM2M TR-0017: "Home Domain Abstract Information Model".
[i.3] ETSI TS 118 101: "Functional Architecture (oneM2M TS-0001)".
[i.4] IEEE 802.15.4™: "IEEE Standard for Local and metropolitan area networks--Part 15.4: Low-Rate
Wireless Personal Area Networks (LR-WPANs)".
[i.5] ETSI TS 118 112: "Base Ontology (oneM2M TS-0012)".
ETSI

---------------------- Page: 6 ----------------------
oneM2M TS-0023 version 2.0.0 Release 2 7 ETSI TS 118 123 V2.0.0 (2016-09)
3 Definitions
For the purposes of the present document, the following terms and definitions apply:
Device Class ID: URN to identify the Device model definition.
ModuleClass ID: URN to identify the ModuleClass model definition
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 Home Appliance Information Model
5.1 Introduction
The present document intends to provide the unified means in the oneM2M system by defining a home appliance
information model for the home domain devices such as TV, refrigerator, air conditioner, clothes washer, oven, and
robot cleaner. For the reasons of interworking with external technologies and efficiency, the principle of the home
appliance information model is designed based on HGI SDT 3.0 [1].
The principle of defining the home appliance information model is introduced in clause 5.2. ModuleClasses which
oneM2M systems support are explained in clause 5.3. In the subsequent clause 5.4, Device models are defined.
5.2 Design Principle of the Home Appliance Information Model
5.2.1 Basic design principle of information modelling
The design principle of the oneM2M abstract information model of home appliance, is to use SDT 3.0 as introduced in
oneM2M TR-0017 [i.2]. Note that those terms starting with a capital letter in this clause are SDT terms and are
explained in [1].
Domain is a unique name which acts like a namespace (e.g. "org.oneM2M.home.modules"). It is set by the organization
creating the SDT, allowing reference to a package of definitions for the contained ModuleClasses and Device models.
ModuleClasses specifies a single service (e.g. audioVolume, powerOn/Off) with one or more Actions, Properties,
DataPoints and Events. Each service which is described as a ModuleClass can be re-used in many Devices.
Device model is a physical, addressable, identifiable appliance, sensor and actuator with one or more Modules,
Properties and SubDevices.
SubDevice is a device which may be embedded in a Device and/or is addressed via another Device.
Module is an instantiation of a ModuleClass for a specific Device or SubDevice.
Figure 5.2.1-1 depicts the basic structure of SDT 3.0.
ETSI

---------------------- Page: 7 ----------------------
oneM2M TS-0023 version 2.0.0 Release 2 8 ETSI TS 118 123 V2.0.0 (2016-09)

Figure 5.2.1-1: Design Structure of the Home Appliance Information Model using SDT 3.0
5.2.2 Description rules for Module Classes and Device models
When the Home Appliances Information Model is described based on SDT, the following rules shall be applied:
• Rule 1: CamelCase rule:
- When naming each element, lowerCamelCase shall be used as the Java coding rules [2].
• Rule 2: Rule for description of Action, DataPoint:
- DataPoint shall be used to represent stateless operations (e.g. powerState of binarySwitch for on/off
operations).
- Action shall be used when describing stateful condition, handling unknown internal state conditions
(e.g. upVolume/downVolume by increasing/decreasing the audioVolume in steps, handling transactional
procedures, or checking integrity using username plus password at the same time).
• Rule 3: Rule for description of DataPoint and Property:
- Non-functional information shall be described as a Property. Functional information shall be described as
a DataPoint (e.g. non-functional information: version, id; functional information: targetTemperature,
targetVolume).
• Rule 4: Definition of the Domain:
- The Domain, in the case of the Home Appliance Information Model, is specified as "org.onem2m.home".
- The sub-domain for Device and ModuleClass shall be specified as "org.onem2m.home.devices" and
"org.onem2m.home.moduleclasses" respectively.
• Rule 5: Naming rule for the element:
- the name of each element should be concise and avoid repeating its parent element name; but
- it may include the name of its parent element for readability. (e.g. lightDimmerUp, lightDimmerDown
under lightDimmer).
• Rule 6: Criteria for marking elements as optional or mandatory:
- An element shall only be defined as mandatory if it's foreseen to be universally mandatory to all
implementing technologies.
• Rule 7: Enumeration type:
- When describing the meaning of values for enumeration type elements, they may be described in another
clause.
ETSI

---------------------- Page: 8 ----------------------
oneM2M TS-0023 version 2.0.0 Release 2 9 ETSI TS 118 123 V2.0.0 (2016-09)
The enumeration types for Home Appliance Information Model are based on , and the numeric values are
interpreted as specified in clause 5.5.
5.3 ModuleClasses
5.3.1 alarmSpeaker
This ModuleClass provides the capability to initiate an alarm.
Table 5.3.1-1: DataPoints of alarmSpeaker ModuleClass
Name Type Readable Writable Optional Documentation
tone hd:tone true true true Representing the tones of the alarm
light hd: true true true Representing the lighting mode of the alarm.
alertColour
Code
alarmStatus xs:boolean true true false "True" indicates the alarm start while "False"
indicates the alarm stop.

5.3.2 audioVideoInput
This ModuleClass provides capabilities to control and monitor audio video input source of device such as TV or
SetTopBox.
Table 5.3.2-1: DataPoints of audioVideoInput ModuleClass
Name Type Readable Writable Optional Documentation
inputSourceID xs:integer true true false Activated input source ID in the supported
input source list, supportedInputSources.
supportedInput list of true false false
List of supported input sources for the
Sources hd:supportedInputS
given device (see clause 5.5.2).
ource

5.3.3 audioVolume
This ModuleClass provides capabilities to control and monitor volume.
Table 5.3.3-1: Actions of audioVolume
Return Name Argument Optional Documentation
Type
none upVolume none true Increase volume by the amount of the
stepValue up to the maxValue.
none downVolume none true Decrease volume by the amount of the
stepValue down to 0.

Table 5.3.3-2: DataPoints of audioVolume
Name Type Readable Writable Optional Documentation
volumePercent xs:integer true true false The rounded percentage of the current volume in
age the range of [0, maxValue]. 0 percentage shall
mean no sound produced.
stepValue xs:integer true false true Step value used by UpVolume and DownVolume
Actions.
maxValue xs:integer true false true Maximum value allowed for Volume.
muteEnabled xs:boolean true true false The current status of the mute enablement.
"True" indicates enabled, and "False" indicates
not enabled.

ETSI

---------------------- Page: 9 ----------------------
oneM2M TS-0023 version 2.0.0 Release 2 10 ETSI TS 118 123 V2.0.0 (2016-09)
5.3.4 battery
Battery indicates the detection of low battery and gives an alarm if triggering criterion is met. The charge value in the
module shows the current battery charge level.
Table 5.3.4-1: DataPoints of battery ModuleClass
Name Type Readable Writable Optional Documentation
level xs:integer true false false The rounded percentage of the current level of
battery in the range of [0, 100]. 0 percentage shall
mean no battery remained.
capacity xs:integer true false true The total capacity of battery in mAh.
charging xs:boolean true false true The status of charging. "True" indicates enabled,
and "False" indicates not enabled.
discharging xs:boolean true false true The status of discharging. "True" indicates
enabled, and "False" indicates not enabled.
lowBattery xs:boolean true false true To indicate that the batter
...