ETSI TS 118 123 V2.0.2 (2020-03)

ETSI TS 118 123 V2.0.2 (2020-03)






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

---------------------- Page: 1 ----------------------
oneM2M TS-0023 version 2.0.2 Release 2A 2 ETSI TS 118 123 V2.0.2 (2020-03)



Reference
RTS/oneM2M-000023v2A
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 prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
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.

© ETSI 2020.
All rights reserved.

DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.

3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners.
®
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI

---------------------- Page: 2 ----------------------
oneM2M TS-0023 version 2.0.2 Release 2A 3 ETSI TS 118 123 V2.0.2 (2020-03)
Contents
Intellectual Property Rights . 6
Foreword . 6
1 Scope . 7
2 References . 7
2.1 Normative references . 7
2.2 Informative references . 7
3 Definition of terms, symbols and abbreviations . 8
3.1 Terms . 8
3.2 Symbols . 8
3.3 Abbreviations . 8
4 Conventions . 8
5 Home Appliance Information Model . 8
5.1 Introduction . 8
5.2 Design Principle of the Home Appliance Information Model . 8
5.2.1 Basic design principle of information modelling . 8
5.2.2 Description rules for Module Classes and Device models . 9
5.3 ModuleClasses . 10
5.3.1 alarmSpeaker . 10
5.3.2 audioVideoInput . 10
5.3.3 audioVolume. 10
5.3.4 battery . 11
5.3.5 binarySwitch . 11
5.3.6 bioElectricalImpedance Anal ysis . 12
5.3.7 boiler . 12
5.3.8 brightness . 12
5.3.9 clock . 12
5.3.10 colour . 13
5.3.11 colourSaturation . 13
5.3.12 doorStatus . 13
5.3.13 electricVehicleConnector . 13
5.3.14 energyConsumption . 14
5.3.15 energyGeneration . 14
5.3.16 faultDetection . 14
5.3.17 height . 15
5.3.18 hotWaterSupply . 15
5.3.19 keypad . 15
5.3.20 motionSensor . 15
5.3.21 oximeter . 16
5.3.22 powerSave. 16
5.3.23 pushButton . 16
5.3.24 recorder . 16
5.3.25 refrigeration . 17
5.3.26 relativeHumidity . 17
5.3.27 rinseLevel . 17
5.3.28 runMode . 17
5.3.29 signalStrength . 18
5.3.30 smokeSensor . 18
5.3.31 spinLevel . 18
5.3.32 televisionChannel . 18
5.3.33 temperature . 19
5.3.34 temperatureAlarm . 19
5.3.35 timer . 19
5.3.36 turbo . 20
5.3.37 waterFlow . 21
ETSI

---------------------- Page: 3 ----------------------
oneM2M TS-0023 version 2.0.2 Release 2A 4 ETSI TS 118 123 V2.0.2 (2020-03)
5.3.38 waterLevel . 21
5.3.39 waterSensor. 21
5.3.40 weight . 21
5.3.41 wind . 21
5.4 Device models . 22
5.4.1 deviceAirConditioner. 22
5.4.2 deviceClothesWasher. 22
5.4.3 deviceElectricVehicleCharger . 23
5.4.4 deviceLight . 23
5.4.5 deviceMicrogeneration . 23
5.4.6 deviceOven . 24
5.4.7 deviceRefrigerator . 24
5.4.8 deviceRobotCleaner . 24
5.4.9 deviceSmartElectricMeter . 24
5.4.10 deviceStorageBattery . 25
5.4.11 deviceTelevision . 25
5.4.12 deviceThermostat . 25
5.4.13 deviceWaterHeater. 26
5.5 Enumeration type definitions . 26
5.5.1 hd:deviceType . 26
5.5.2 hd:supportedInputSources . 26
5.5.3 hd:liquidLevel . 27
5.5.4 hd:spinLevelStrength . 27
5.5.5 hd:doorState . 27
5.5.6 hd:tone . 27
5.5.7 hd:supportedModes . 28
5.5.8 hd:alertColourCode . 28
5.5.9 hd:waterFlowStrength . 28
5.5.10 hd:windStrength . 29
5.6 Universal and Common Properties for Device models . 29
6 The Principle of Resource Mapping for Home Appliance Information Model. 30
6.1 Introduction . 30
6.2 The Resource Mapping Rules . 30
6.2.1 Introduction. 30
6.2.2 Resource mapping for Device model . 30
6.2.3 Resource mapping for ModuleClass . 31
6.2.4 Resource mapping for Action . 31
6.2.5 Resource mapping for Property . 31
6.2.6 Resource mapping for DataPoint . 31
6.3 Short names . 32
6.3.1 Introduction. 32
6.3.2 Resource types . 32
6.3.3 Resource attributes for properties and data points . 33
6.4 containerDefinition values. 36
6.4.1 Introduction. 36
6.4.2 Device models . 36
6.4.3 ModuleClasses . 36
6.4.4 Actions . 37
6.5 XSD definitions . 37
6.5.1 Introduction. 37
6.5.2 XSD definitions for Device models . 37
6.5.3 XSD definitions for ModuleClass . 38
6.5.4 XSD definitions for Action . 39
7 Mapping with Other Information Models from External Organizations . 39
8 Ontology for the Home Appliance Information Model aligned with oneM2M Base Ontology . 39
Annex A (informative): Resource Mapping Examples . 41
A.1 Introduction . 41
A.2 Example for Device model 'deviceAirConditioner' . 41
ETSI

---------------------- Page: 4 ----------------------
oneM2M TS-0023 version 2.0.2 Release 2A 5 ETSI TS 118 123 V2.0.2 (2020-03)
A.3 Example of ModuleClass 'binarySwitch' . 45
A.4 Example of Action 'toggle' . 46
History . 47

ETSI

---------------------- Page: 5 ----------------------
oneM2M TS-0023 version 2.0.2 Release 2A 6 ETSI TS 118 123 V2.0.2 (2020-03)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables 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.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Foreword
This Technical Specification (TS) has been produced by ETSI Partnership Project oneM2M (oneM2M).
ETSI

---------------------- Page: 6 ----------------------
oneM2M TS-0023 version 2.0.2 Release 2A 7 ETSI TS 118 123 V2.0.2 (2020-03)
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.
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] ETSI TR 118 517: "oneM2M; Home Domain Abstract Information Model (oneM2M TR-0017)".
[i.3] ETSI TS 118 101: "oneM2M; 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: "oneM2M; Base Ontology (oneM2M TS-0012)".
ETSI

---------------------- Page: 7 ----------------------
oneM2M TS-0023 version 2.0.2 Release 2A 8 ETSI TS 118 123 V2.0.2 (2020-03)
3 Definition of terms, symbols and abbreviations
3.1 Terms
For the purposes of the present document, the following terms apply:
Device Class ID: URN to identify the Device model definition
ModuleClass ID: URN to identify the ModuleClass model definition
3.2 Symbols
Void.
3.3 Abbreviations
Void.
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
ETSI TR 118 517 [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.
ETSI

---------------------- Page: 8 ----------------------
oneM2M TS-0023 version 2.0.2 Release 2A 9 ETSI TS 118 123 V2.0.2 (2020-03)
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 [i.2].

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
...