hash
stringlengths
32
32
doc_id
stringlengths
7
13
section
stringlengths
3
121
content
stringlengths
0
2.2M
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.5.6.1 deviceElectricVehicleCharger
An electric vehicle charger is a device that is used for charging or discharging electric vehicles. Table 5.5.6.1-1: Modules of deviceElectricVehicleCharger Device model Module Instance Name Module Class Name Multiplicity Description faultDetection faultDetection 1 See clause 5.3.1.34. binarySwitch binarySwitch 1 See c...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.5.7 Agriculture Domain
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.5.7.1 deviceCowActivityMonitor
A cow activity monitor device is a battery-powered wireless metering device that is used to measure the activity data (e.g. step count) of a cow in the dairy farming industry. The collected data can be used to analyse and predict the estrus of the cow for better mating and milk production. Table 5.5.7.1-1: Modules of d...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.5.8 Railway Domain
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.5.8.1 deviceHandheldPTTTerminal
A handheld Push-to-Talk (PTT) terminal is a device of the Railway Domain. The terminal is usually used between the railway workers including train driver, crew and rail-side worker to share their work status via voice communication. Table 5.5.8.1-1: Modules of deviceHandheldPTTTerminal Device model Module Instance Name...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.5.8.2 deviceTrainborneTerminal
A handheld Push-to-Talk (PTT) terminal is a device of the Railway Domain. The terminal is usually used between the railway workers including train driver, crew and rail-side worker to share their work status via voice communication. Table 5.5.8.2-1: Modules of deviceTrainborneTerminal Device model Module Instance Name ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.5.8.3 deviceCardRechargingMachine
A card recharging machine is a device of the Railway Domain. The machine provides recharging service for pre-paid card for transportation. Railway users simply recharging their cards and use it as a payment method for transportation fare. Table 5.5.8.3-1: Modules of deviceCardRecharingMachine Device model Module Instan...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.5.8.4 deviceSmartGate
A smart gate is a device of the Railway Domain. The gate provides passenger service for checking ticket and control the gate usage. A railway users simply use the gate with their ticket (e.g. passenger card) which have pre-paid card function. Table 5.5.8.4-1: Modules of deviceSmartGate Device model Module Instance Name...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.5.8.5 deviceSmartScreenDoor
A smart screen door is a device of the Railway Domain. The screen doors are pairs of sliding doors in a platform with synchronization of doors of a train that is staying in the platform. When the train doors are open, the smart screen doors are open in simultaneously, and vice versa. The screen doors are used in the me...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6 Enumeration type definitions
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.0 Introduction
All enumeration types are defined in the same domain, Horizontal Domain, prefix 'hd'.
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.1 hd:enum3DprinterTechnology
Used for the "printType" data point of the "3Dprinter" ModuleClass. Table 5.6.1-1: Interpretation of hd:enum3DprinterTechnology Value Interpretation Note 1 Fused Filament Fabrication FFF 2 Fused Deposition Modelling FDM 3 Digital Light Processing DLP 4 Powder Bed & inkjet head 3D Printing PBP 5 Photopolymer Jetting Tec...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.2 hd:enumAdfState
Used for the "currentAdfState" and "adfStates" data points of the "autoDocumentFeeder" ModuleClass. Table 5.6.2-1: Interpretation of hd:enumAdfState Value Interpretation Note 1 processing 2 empty 3 jam 4 loaded 5 mispick The product did not pick up the paper in the document feeder. 6 hatchOpen The product hatch is open...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.3 hd:enumAirConJobMode
Used for the "currentJobMode" and "jobModes" data point of the "airConJobMode" ModuleClass. Table 5.6.3-1: Interpretation of hd:enumAirConJobMode Value Interpretation Note 1 cool This value is for deviceAirConditioner and indicates cool mode. 2 airDry This value is for deviceAirConditioner and indicates air dry mode. 3...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.4 hd:enumAirPurifierJobMode
Used for the "currentJobMode" and "jobModes" data points of the "airPurifierJobMode" ModuleClass. Table 5.6.4-1: Interpretation of hd:enumAirPurifierJobMode Value Interpretation Note 1 normalClean This indicates the normal mode that operates the basic function. 2 sleep This indicates the sleep mode that turns the opera...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.5 hd:enumAlertColourCode
Used for the "light" data point of the "alarmSpeaker" ModuleClass. Table 5.6.5-1: Interpretation of hd:enumAlertColourCode Value Interpretation Note 1 red This colour indicates the alarm status. 2 green This colour indicates the alarm has been cleared. NOTE: See clause 5.3.1.7 "alarmSpeaker".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.6 hd:enumCallState
Used for the "callState" data point in the "phoneCall" ModuleClass. Table 5.6.6-1: Interpretation of hd:enumCallState Value Interpretation Note 1 hangup 2 calling 3 ringing 4 busy 5 answered 6 noline 7 voicemail 8 redirected NOTE: See clause 5.3.1.64 "phoneCall".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.7 hd:enumClothesDryerJobMode
Used for the "currentJobMode" and "jobModes" data points of the "clothesDryerJobMode" ModuleClass. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 81 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.7-1: Interpretation of hd:enumClothesDryerJobMode Value Interpretation Note 1 normal Normal cycle. 2 quickDry About half the length...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.8 hd:enumClothesWasherDryerJobMode
Used for "currentJobModes" and "jobModes" data points of "clothesWasherDryerJobMode" ModuleClass. Manufacturers can define their own courses by setting this value to negative values. Table 5.6.8-1: Interpretation of hd:enumClothesWasherJobMode Value Interpretation Note 1 normal 2 quick 3 auto 4 delicates 5 heavy duty N...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.9 hd:enumClothesWasherJobMode
Used for the "currentJobModes" and "jobModes " data points of the "clothesWasherJobMode" ModuleClass. Washing options such as water temperature and spin speed are decided to pre-set values upon selected washing course. Manufacturers can define their own courses by setting this value to negative values. Table 5.6.9-1: I...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.10 hd:enumCookerHoodJobMode
Used for the "currentJobMode" and "jobModes" DataPoints of the "cookerHoodJobMode" ModuleClass. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 82 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.10-1: Interpretation of hd:enumCookerHoodJobMode Value Interpretation Note 1 Always-on This value indicates the always-on mode which k...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.11 hd:enumDehumidifierJobMode
Used for "currentJobMode" and "jobModes" data points of the "dehumidifierJobMode" ModuleClass. Table 5.6.11-1: Interpretation of hd:enumDehumidifierJobMode Value Interpretation Note 1 smart This value indicates the smart mode that first gets the target humidity level from user input, next detects the correct relative h...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.12 hd:enumDishWasherJobMode
Used for the "currentJobMode" and "jobModes" DataPoints of the "dishWasherJobMode" ModuleClass. Table 5.6.12-1: Interpretation of hd:enumDishWasherJobMode Value Interpretation Note 1 Normal wash 2 Intensive wash 3 Quick wash 4 Sensor wash 5 Eco wash 6 Quiet wash 7 Maintenance wash NOTE: See clause 5.3.1.29 "dishWasherJ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.13 hd:enumDisplayOrder
Used for the "displayOrder" data point of the "galleryMode" ModuleClass. Table 5.6.13-1: Interpretation of hd:enumDisplayOrder Value Interpretation Note 1 fixed 2 sequence 3 loop 4 random ETSI ETSI TS 118 123 V4.8.1 (2024-02) 83 oneM2M TS-0023 version 4.8.1 Release 4
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.14 hd:enumDisplayOrientation
Used for the "displayOrientation" data point of the "galleryMode" ModuleClass. Table 5.6.14-1: Interpretation of hd:enumDisplayOrientation Value Interpretation Note 1 landscape 2 portrait
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.15 hd:enumDoorState
Used for the "doorState" DataPoint of "doorStatus" ModuleClass. Table 5.6.15-1: Interpretation of hd:enumDoorState Value Interpretation Note 1 closed This indicates that door is closed. 2 open This indicates that the door is open. 3 opening This indicates that the door is opening. 4 closing This indicates that the door...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.16 hd:enumFoamStrength
Used for data points indicating the strength of a foam, for example, foaming milk from a coffee machine. Table 5.6.16-1: Interpretation of hd:enumFoamStrength Value Interpretation Note 1 zero 2 low 3 medium 4 high 5 maximum NOTE: See clause 5.3.1.36 "foaming".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.17 hd:enumGeneralLevel
Used for the "soilLevel" data point of the "washingCourseOption" ModuleClass. Table 5.6.17-1: Interpretation of hd:enumGeneralLevel Value Interpretation Note 1 light 2 normal 3 heavy NOTE: See clause 5.3.1.22 clothesWasherJobModeOption.
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.18 hd:enumGeneralSpeed
Used for the "spinSpeed" data point of the "washingCourseOption" ModuleClass. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 84 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.18-1: Interpretation of hd:enumGeneralSpeed Value Interpretation Note 1 low 2 medium 3 high 4 extraHigh NOTE: See clause 5.3.1.22 clothesWasherJobModeOp...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.19 hd:enumGeneralTemperature
Used for the "washTemp" data point of the "washingCourseOption" ModuleClass. Table 5.6.19-1: Interpretation of hd:enumGeneralTemperature Value Interpretation Note 1 cold The actual temperature is defined by the manufacturer. 2 warm 3 hot NOTE: See clause 5.3.1.22 clothesWasherJobModeOption.
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.20 hd:enumGrainsLevel
Used for the "grainsRemaining" data point of the "grinder" ModuleClass. This type specifies a level for supplies that have a grain-aspect, for example the level of remaining coffee beans in the grinder part of a coffee machine, or the desired level of coffee beans in this machine. The values for the level of a liquid i...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.21 hd:enumGrindCoarseness
Used for the coarseness data points of the "grinder" ModuleClass. This type specifies the level of coarseness of a solid after grinding, for example grinded coffee beans. Table 5.6.21-1: Interpretation of hd:enumGrindCoarseness Value Interpretation Note 1 ultrafine 2 fine 3 medium 4 coarse 5 coarsest NOTE: See clause 5...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.22 hd:enumHorizontalDirection
Used for the "horizontalDirection" and "supportedHorizontalDirection" of the "airflow" ModuleClass, indicating horizontal directions. Table 5.6.22-1: Interpretation of hd:enumHorizontalDirection Value Interpretation Note 1 auto 2 center 3 left 4 right NOTE: See clause 5.3.1.4 "airFlow".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.23 hd:enumJobStates
Used for the "currentJobState" and "jobStates" data points of the "runState" ModuleClass. Table 5.6.23-1: Interpretation of hd:enumJobState Value Interpretation Note 1 aborted 2 cancelled 3 completed 4 paused 5 pending 6 processing NOTE: See clause 5.3.1.75 "runstate".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.24 hd:enumLiquidLevel
Used for the "liquidLevel" and "liquidRemaining" data points in the respective "liquidLevel" and "liquidRemaining" ModuleClasses. Table 5.6.24-1: Interpretation of hd:LiquidLevel Value Interpretation Note 1 zero 2 low 3 medium 4 high 5 maximum NOTE: See clause 5.3.1.50 "liquidLevel" and clause 5.3.1.51 "liquidRemaining...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.25 hd:enumMachineState
Used for the "currentMachineState" and "machineStates" data points of the "runState" ModuleClass. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 86 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.25-1: Interpretation of hd:enumMachineState Value Interpretation Note 1 idle Machine is ready to operate 2 preActive Machine is oper...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.26 hd:enumOzoneStatus
Used for the "ozoneStatus" property of the "ozoneMeter" ModuleClass. Table 5.6.26-1: Interpretation of hd:enumOzoneStatus Value Interpretation Note 1 Good For example, 0 ppm to 0,030 ppm. 2 Normal For example, 0,031 ppm to 0,090 ppm. 3 Bad For example, 0,091 ppm to 0,150ppm. 4 Very bad For example, 0,151 ppm or above. ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.27 hd:enumPlayerMode
Used for the "currentMode" and "supportedModes" data points in the "playerControl" ModuleClass. Table 5.6.27-1: Interpretation of hd:enumPlayerMode Value Interpretation Note 1 stop 2 play 3 pause 4 resume 5 record 6 rewind 7 fast-rewind 8 forward 9 fast-forward 10 searchPrevious 11 searchNext NOTE: See clause 5.3.1.65 ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.28 hd:enumRobotCleanerJobMode
Used for the "currentJobMode" and "jobModes" data points of the "robotCleanerJobMode" ModuleClass. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 87 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.28-1: Interpretation of hd:enumRobotCleanerJobMode Value Interpretation Note 1 zigzag The machine moves forward by going at an angl...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.29 hd:enumSecurityMode
Used for the "currentSecurityMode" and "securityModes" data points of the "securityMode" ModuleClass. Table 5.6.29-1: Interpretation of hd:enumSecurityMode Value Interpretation Note 1 active Unit is active 2 armedAway Unit is armed for away 3 armedInstant Unit is armed instantly 4 armedMaximum Unit is armed at maximum ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.30 hd:enumSpinLevelStrength
Used for the "spinLevelStrength" data points of the "spinLevel" ModuleClass, indicating the strength of a spinLevel. Table 5.6.30-1: Interpretation of hd:enumSpinLevelStrength Value Interpretation Note 1 zero 2 sensitive 3 weak 4 medium 5 strong 6 maximum NOTE: See clause 5.3.1.84 "spinLevel".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.31 hd:enumSteamClosetJobMode
Used for "currentJobMode" and "jobModes" data points of the "steamClosetJobMode" ModuleClass. Table 5.6.31-1: Interpretation of hd:enumSteamClosetJobMode Value Interpretation Note 1 reduceOdor Using pure water, the machine help remove the smells on clothes. 2 steamWrinkle The machine steams away wrinkles and also creat...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.32 hd:enumSupportedMediaSources
Used for the "supportedMediaSources" data point of the "mediaSelect" ModuleClass. Table 5.6.32-1: Interpretation of hd:enumSupportedMediaSources Value Interpretation Note 1 tuner 2 component 3 composite 4 svideo 5 rgb 6 dvi 7 hdmi 8 displayPort 9 scart 10 externalStorage 11 network NOTE: See clause 5.3.1.53 "mediaSelec...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.33 hd:enumTasteStrength
Used for the "strength" data point of the "brewing" ModuleClass, indicating strength of a drink taste, for example coffee strength. Table 5.6.33-1: Interpretation of hd:enumTasteStrength Value Interpretation Note 1 zero 2 sensitive 3 medium 4 strong 5 maximum NOTE: See clause 5.3.1.16 "brewing"
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.34 hd:enumTone
Used for the "tone" data point of the "alarmSpeaker" ModuleClass. Table 5.6.34-1: Interpretation of hd:enumTone Value Interpretation Note 1 fire 2 theft 3 emergency 4 doorbell 5 deviceFail NOTE: See clause 5.3.1.7 "alarmSpeaker".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.35 hd:enumUvStatus
Used for the "uvStatus" data point of the "uvSensor" ModuleClass. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 89 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.35-1: Interpretation of hd:enumUvStatus Value Interpretation Note 1 Good 2 Normal 3 Bad 4 Very Bad 5 Danger NOTE: See clause 5.3.1.92 "uvSensor".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.36 hd:enumVerticalDirection
Used for the "verticalDirection" and "supportedVerticalDirection" data points of the "airFlow" ModuleClass, indicating vertical direction. Table 5.6.36-1: Interpretation of hd:enumVerticalDirection Value Interpretation Note 1 auto 2 center 3 up 4 down NOTE: See clause 5.3.1.4 "airFlow".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.37 hd:enumWaterFlowStrength
Used for the "waterLevelStrength" data point of the "waterFlow" ModuleClass, indicating the strength of a waterflow. Table 5.6.37-1: Interpretation of hd:enumWaterFlowStrength Value Interpretation Note 1 zero 2 sensitive 3 weak 4 medium 5 strong 6 maximum NOTE: See clause 5.3.1.93 "waterFlow".
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.38 hd:enumBaliseSystemIndicator
Used for the "baliseTransmissionModule" ModuleClass. Table 5.6.38-1: Interpretation of hd:enumBaliseSystemIndicator Value Interpretation Note 1 ATC Korea [i.9] 2 ATP Korea [i.9] 3 CTCS-3 China [i.10] NOTE: The Note shows countries which are using a balise system which is indicated on left-hand side.
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.39 hd:enumWeight
Used for the "unit" data point related to all ModuleClass which contains weight, indicating the units of the weight. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 90 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.39-1: Interpretation of hd:enumWeight Value Interpretation Note 1 kg kilogram 2 lb pound 3 oz ounce NOTE: See cla...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.40 hd:enumTemperatureUnit
Used for the "unit" data point related to "temperature" and "temperatureAlarm" ModuleClass which contains temperature, indicating the units of the temperature. Table 5.6.40-1: Interpretation of hd:enumTemperatureUnit Value Interpretation Note 1 kgC Celsiuskilogram 2 lbF Fahrenheitpound 3 ozK Kelvinounce NOTE: See claus...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.41 hd:enumWaterFilterType
Used for the "filterType" data point of the "waterFilterType" ModuleClass. Table 5.6.41-1: Interpretation of hd:enumWaterFilterType Value Interpretation Note 1 RO This value indicates the Revers Osmosis type water filter. 2 UV This value indicates the Ultraviolet type water filter. 3 UF This value indicates the UltraFi...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.42 hd:enumDataModelType
Used for the "dataModelType" DataPoint of the "dmAgent" ModuleClass. Table 5.6.42-1: Interpretation of hd:enumDataModelType Value Interpretation Note 1 unknown To be used for a proprietary/unknown protocol 2 OMA DM 1.3 3 OMA DM 2.0 4 OMA LwM2M 5 BBF TR-181 CWMP Version of TR-181 [i.12] for TR-069 [i.11] 6 BBF TR-181 US...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.43 hd:enumDmAgentState
Used for the "state" DataPoint of the "dmAgent" ModuleClass. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 91 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.43-1: Interpretation of hd:enumDmAgentState Value Interpretation Note 1 ready The device is ready for DM operations 2 error The device is known to be in an error state 3...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.44 hd:enumFirmwareState
Used for the "state" DataPoint of the "dmFirmware" ModuleClass. Table 5.6.44-1: Interpretation of hd:enumFirmwareState Value Interpretation Note 1 Active The firmware is currently active 2 Ready The firmware is ready for installation/activation 3 Downloading The firmware is being downloaded 4 Installing The firmware in...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.45 hd:enumPowerState
Used for the "powerStatus" DataPoint of the "dmAgent" ModuleClass. Table 5.6.45-1: Interpretation of hd:enumPowerState Value Interpretation Note 1 normal 2 charging 3 chargingComplete 4 degraded 5 low 6 critical 7 notInstalled
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.46 hd:enumRebootType
Used for the "rebootType" argument of the "reboot" action of the "dmAgent" ModuleClass. Table 5.6.46-1: Interpretation of hd:enumRebootType Value Interpretation Note 1 reboot 2 rebootWhenReady Reboot needed when the device is available for it 3 factoryReset "hard" reset 4 softReset
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.47 hd:enumSoftwareState
Used for the "state" data point of the "dmSoftware" ModuleClass. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 92 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.47-1: Interpretation of hd:enumSoftwareState Value Interpretation Note 1 Inactive 2 Activating 3 Active 4 Deactivating
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.48 hd:enumPackageState
Used for the "state" data point of the "dmPackage" ModuleClass. Table 5.6.48-1: Interpretation of hd:enumPackageState Value Interpretation Note 1 NotInstalled 2 Downloaded 3 Installed 4 Downloading 5 Installing 6 Uninstalling
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.49 hd:enumPackageType
Used for the "type" data point of the "dmPackage" ModuleClass. Table 5.6.49-1: Interpretation of hd:enumPackageType Value Interpretation Note 1 SoftwareModule Software module image (executable) 2 SoftwareLibrary Software library file 3 WebContent Web document 4 ConfigFile Configuration file 5 VendorFile Vendor-specific...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.50 hd:enumBatteryMaterial
Used for the "batteryMaterial" DataPoint of the "battery" ModuleClass. Table 5.6.50-1: Interpretation of hd:enumBatteryMaterial Value Interpretation Note 1 Alkaline_battery Primary cells or non-rechargeables 2 Lithium_battery Primary cells or non-rechargeables 3 Magnesium_battery Primary cells or non-rechargeables 4 Me...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.51 hd:enumBatteryShape
Used for the "batteryShape" DataPoint of the "battery" ModuleClass. Table 5.6.51-1: Interpretation of hd:enumBatteryShape Value Interpretation Note 1 AA Cylinder-type AA battery 2 AAA Cylinder-type AAA battery 3 AAAA Cylinder-type AAAA battery 4 C Cylinder-type C battery 5 D Cylinder-type D battery 6 N Cylinder-type N ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.52 hd:enum3DDisplayType
Used for the "3DDisplayType" DataPoint of the "3DDisplay" ModuleClass. Table 5.6.52-1: Interpretation of hd:enum3DDisplayType Value Interpretation Note 1 Stereoscopic Display Use "binocular disparity" method to implement 3D display. The technology uses 3D glasses to make the binocular disparity. 2 Light Field Display T...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.6.53 hd:enum3DScannerType
Used for the "3DScannerType" DataPoint of the "3DScanner" ModuleClass. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 94 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.6.53-1: Interpretation of cod:enum3DScannerType Value Interpretation Note 1 TOF Use "Time Of Flight" method to scan 3D object. The technology calculates time gap...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.7 Universal and Common Properties for Device models
Universal and common properties are defined either as the specialized [objectAttribute]s of the [deviceInfo] resource in clause D.8 of ETSI TS 118 101 [i.3] when the Device model contains a nodeLink attribute that links to a <node> resource, or as specialized custom attributes of the [dmDeviceInfo] in clause 5.8.3 when...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8 Device Management
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.0 Introduction
The entities that are specified in this clause allow performing classical Device Management (DM) functions: rebooting a device, upgrading it, reading / setting its configuration, monitoring its logs, checking its memory or battery status, managing its firmware or its software modules, etc. They belong to the "managemen...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.1 flexNode
This flexContainer specialization is the root for SDT-based Device Management modules. The containerDefinition attribute of this specialization shall be "org.onem2m.management.device.flexNode". It is targeted by the flexNodeLink attribute of <flexContainer> SDT devices (see in clause 6.2.2 the rules 1-6, 1-7 and 1-8). ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.2 dmAgent
This ModuleClass is the entry point module of [flexNode]; it provides capabilities to control and monitor the Device Management of the device. Table 5.8.2-1: Actions of dmAgent ModuleClass Return Type Name Arguments Optional Description none reboot rebootType: hd:enumRebootType false Execute a reboot or a factory reset...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.3 dmDeviceInfo
This ModuleClass is used to share static information regarding the device. Table 5.8.3-1: DataPoints of dmDeviceInfo ModuleClass Name Type R/W Optional Unit Description serialNumber xs:string R true Unique device label assigned by the manufacturer. The value of the datapoint typically exposes the device's serial number...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.4 dmDataModelIO
This ModuleClass provides capabilities to handle the device's Data Model for cases where the underlying Device Management technology supports APIs that are not directly reflected in the flexNode modules. Table 5.8.4-1: Actions of dmDataModelIO ModuleClass Return Type Name Arguments Optional Description xs:string readIO...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.5 dmFirmware
This ModuleClass provides Device Management capabilities to control and monitor the firmware of a device. The device can contain multiple components (a graphic card for instance) that can have individual firmwares, and they need to be managed separately. The [flexNode] allows one [dmFirmware] module per component plus ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.6 dmSoftware
This ModuleClass provides DM capabilities to control and monitor software modules of the device. An instance of this module class represents a software module hosted by the device. Archival Active Downloading Active Downloading Archival Installing PRIMARY SECONDARY T O G G L E Installing Ready Ready Failure Failure ETS...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.7 dmEventLog
This ModuleClass provides DM capabilities to control and monitor event logs of the device. Table 5.8.7-1: Actions of dmEventLog ModuleClass Return Type Name Arguments Optional Description none retrieveLog start: xs:datetime end: xs:datetime true Upload from the device the logging data between 'start' and 'end'. 'start'...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.8 dmPackage
This ModuleClass provides DM capabilities to deploy, control and monitor packages of the device: • These packages can be simple resource files such as software libraries, configuration files, etc. In this case the softwares datapoint will be empty. • They also can correspond to software images, in which case their inst...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.9 dmAreaNwkInfo
A dmAreaNwkInfo is a SDT SubDevice entity, mapped as a <flexContainer> resource that expresses the information about the devices in a M2M Area Network managed by the parent flexNode. Table 5.8.9-1: Properties of dmAreaNwkInfo model Property Name Property Type Multiplicity Description areaNwkType xs :string 1 Indicates ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.10 dmAreaNwkDeviceInfo
This ModuleClass is used to share information regarding the devices in the M2M Area Network. Table 5.8.10-1: DataPoints of dmAreaNwkDeviceInfo ModuleClass Name Type R/W Optional Unit Description devId xs:string R false Indicates the id of the device. It could be the id of the hardware or nodeId. devType xs:string R fal...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.11 dmCapability
This ModuleClass is used to model the service capabilities of a managed device. Table 5.8.11-1: Actions of dmCapability ModuleClass Return Type Name Argument Optional Documentation m2m:status enable none true The action that allows enabling the device capability. Returns the status of the action. m2m:status disable non...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
5.8.12 dmStorage
This ModuleClass is used to model the storage on a managed device. Table 5.8.12-1: Actions of dmStorage ModuleClass Return Type Name Argument Optional Documentation none format none true The action that allows to format the mounted storage. none unmount none true The action that allows to safety eject storage device. T...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.1 Introduction
Home appliance information models which are defined in clause 5 need to be represented as resources in the oneM2M system. This clause defines the principle of resource mapping based on <flexContainer>. The individual information mapping is provided in annexes A, B and C.
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.2 The Resource Mapping Rules
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.2.0 Introduction
The present clause specifies the rule to map the "Harmonized Information Model" to oneM2M resources.
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.2.1 Resource mapping for Device model
When the AE exposes a controlling interface for a home domain device which is specified as an information model in clause 5.5, a specialization of the <flexContainer> resource shall be created as the mapping of the model following conversion rules: • Rule 1-1: Each Device model defined in clause 5.5 shall be mapped to ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.2.2 Resource mapping for ModuleClass
The ModuleClass models shall be mapped to the specializations of a <flexContainer> resource. The following rules shall be applied: When the Device or SubDevice models in clauses 5.4, 5.5, 5.8.2 or 5.8.10 are mapped to the <flexContainer> resource, and if the device or sub-device supports the functionality associated wi...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.2.3 Resource mapping for Action
Actions defined as part of a ModuleClass model shall be mapped to the specializations of a <flexContainer> resource. The following rules shall be applied: • Rule 3-1: The containerDefinition attribute shall be set according to clause 6.4.4. • Rule 3-2: When the Action supports any 'Arguments', they are mapped to [custo...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.2.4 Resource mapping for Property
When the Device model (in clause 5.5) or the ModuleClass model (in clause 5.3) is mapped to the <flexContainer> resource, and if the device supports a Property, the following rules shall be applied: • Rule 4-1: Each entry of 'Property' table in ModuleClass model, shall be mapped to the [customAttribute] of <flexContain...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.2.5 Resource mapping for DataPoint
When the ModuleClass model (in clause 5.3) is mapped to the <flexContainer> resource, and if the ModuleClass supports a DataPoint, the following rules shall be applied: • Rule 5-1: Each entry of DataPoint table in ModuleClass model, shall be mapped to [customAttribute] of <flexContainer> resource which is mapped from a...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.2.6 Resource mapping for SubDevice model
The SubDevice models (in clause 5.4 or 5.8.10) shall be mapped to the specializations of a <flexContainer> resource. The following rules shall be applied: • When the SubDevice model in clause 5.4 or 5.8.10 is mapped to the <flexContainer> resource, and if the device supports the functionality associated with a SubDevic...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.3 Short names
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.3.0 Introduction
XML and JSON representations require the explicit encoding of the names of resource attributes, (in the case of XML) and resource types. Whenever a protocol binding transfers such a name over a oneM2M reference point, it shall use a shortened form of that name. Short names enable payload reduction on involved telecommu...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.3.1 Resource types
In protocol bindings resource type names for device models shall be translated into short names of Table 6.3.2-1. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 108 oneM2M TS-0023 version 4.8.1 Release 4 Table 6.3.2-1: Specialization type short names (Device models) Resource Type Name Short Name Device3DPrinter dTDPr deviceAirC...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.3.2 Resource attributes for properties and data points
In protocol bindings resource attributes names for properties of module classes shall be translated into short names of Table 6.3.3-1. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 112 oneM2M TS-0023 version 4.8.1 Release 4 Table 6.3.3-1: Resource attribute short names (ModuleClass properties) Attribute Name Occurs in Short Na...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.3.3 Resource attributes for actions arguments
In protocol bindings resource attributes names for arguments of actions shall be translated into short names of Table 6.3.4-1. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 117 oneM2M TS-0023 version 4.8.1 Release 4 Table 6.3.4-1: Resource attribute short names (Action arguments) Argument Name Occurs in Short Name address read...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.4 containerDefinition values
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.4.1 Introduction
Each specialization has a containerDefinition attribute which can be used as a unique identifier and contains the information of the resource. In this clause, the detailed values of containerDefinition attributes in every specializations for the harmonized information model are given.
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.4.2 Device models
Depending on the domain, the containerDefinition attribute of specializations for device models shall have the values that comply with the following rule: • Rule: "org.onem2m.[domain].device.[device name]", where [domain] is one of the following names: "agriculture", "city", "common", "health", "home", "industry", "rai...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.4.3 ModuleClasses
Depending on the domain, the containerDefinition attribute of specializations for module classes shall have the values that comply with the following rule: • Rule: "org.onem2m.[domain].moduleclass.[moduleclass name]", where [domain] is one of the following names: "agriculture", "city", "common", "health", "home", "indu...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.4.4 Actions
Depending on the domain, the containerDefinition attribute of specializations for actions shall have the values that comply with the following rule: • Rule: "org.onem2m.[domain].action.[action name]", where [domain] is one of the following names: "agriculture", "city", "common", "health", "home", "industry", "railway",...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.4.5 SubDevices
Depending on the domain, the containerDefinition attribute of specializations for sub-devices shall have the values that comply with the following rule: • Rule: "org.onem2m.[domain].subdevice.[subDevice name]", where [domain] is one of the following names: "agriculture", "city", "common", "health", "home", "industry", ...
e6ebfc519c3e089619ef5d1ffe3caa64
118 123
6.5 XSD definitions