hash
stringlengths 32
32
| doc_id
stringlengths 7
13
| section
stringlengths 3
121
| content
stringlengths 0
3.82M
|
---|---|---|---|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.59 oximeter
|
This ModuleClass provides the capability to report the measurement of blood oxygen characteristics. Table 5.3.1.59-1: DataPoints of oximeter ModuleClass Name Type R/W Optional Unit Documentation oxygenSaturation xs:integer R false pct The measurement of oxygensaturation by Oximeter.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.60 ozoneMeter
|
This ModuleClass provides capabilities for an ozone meter. The "ozoneValue…" attributes are optional, but one of them SHALL be provided. Table 5.3.1.60-1: DataPoints of ozoneMeter ModuleClass Name Type R/W Optional Unit Documentation ozoneValuePPM xs:float R true ppm ozoneValueMG xs:float R true mg/m ozoneStatus hd:enumOzoneStatus R true The ozoneStatus indicates the level of ozone status. (see clause 5.6.26). maxValue xs:float R true The maximum value shows the measurement range of the ozone meter (for example maxValue=5 means the range is 0 to 5 ppm). This attribute is only used that the ozoneMeter provides "ppm" value.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.61 magneticSensorParameters
|
This ModuleClass provides capabilities to set service parameters for parking detectors. Table 5.3.1.61-1: DataPoints of magneticSensorParameters ModuleClass Name Type R/W Optional Unit Documentation detectionInterval xs:integer RW false s Time interval for detecting the geomagnetic field strength. initialMagnetic xs:float RW true G The value of initial geomagnetic field strength, which is usually set when the parking detector is initially installed. It may be reset later if the geomagnetic field strength of the local environment is affected by other factors. The value is used as the reference threshold to determine the parkingStatus. When the parking detector detects that the strength of the magnetic field is greater than the initialMagnetic, the parkingStatus is set to "true", otherwise, the parkingStatus is set to "false". magneticSensitivityL evel xs:integer RW true The level of detection sensitivity. It is implementation specific. highMagneticAlarm xs:boolean R false The alarm of high magnetic interference. The alarm threshold is implementation specific.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.62 parkingStatus
|
This ModuleClass provides the status of the parking detector. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 38 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.62-1: DataPoints of parkingStatus ModuleClass Name Type R/W Optional Unit Documentation parkingStatus xs:boolean R false This value indicates the status of the parking space. "False": not occupied. "True": occupied.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.63 periodicalReportConfig
|
This ModuleClass provides capabilities to set parameters of periodic report. Table 5.3.1.63-1: DataPoints of periodicalReportConfig ModuleClass Name Type R/W Optional Unit Documentation backoffTime xs:integer RW false s The number of seconds to wait before connecting to network. period xs:integer RW true s Reporting period. retryTimes xs:integer RW true The maximum number of re-sent attempts in the case of report failure. retryInterval xs:integer RW true s The minimum time interval between each message transmission retry.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.64 phoneCall
|
This ModuleClass provides the capability get or set the caller and recipient IDs as well as to initiate and terminate a call. Table 5.3.1.64-1: Actions of phoneCall ModuleClass Return Type Name Argument Optional Documentation none call none true Initiate an outgoing call. none answer none true Answer (pickup) an incoming call. none hangup none true Hangup an established call. Table 5.3.1.64-2: DataPoints of phoneCall ModuleClass Name Type R/W Optional Unit Documentation callerID xs:string RW false This data point represents the initiating caller identification of a call. In case of an outgoing call this would be the local line ID. This data point is optional. When it is empty for an incoming call, then the caller ID is unknown. When it is empty for an outgoing call, then it is expected that it is set by the PBX or the operator. The format of caller ID is not specified here. recipientID xs:string RW false This data point represents the receiving caller identification of a call. In case of an incoming call this would be the local line ID and optionally extension. The format of caller ID is not specified here. callState hd:enumCallState R true This data point represents the current state of an associated phone device regarding calls.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.65 playerControl
|
This ModuleClass provides capabilities to control and monitor the operational modes of a media player functionality. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 39 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.65-1: Actions of playerControl ModuleClass Return Type Name Argument Optional Documentation none nextTrack none true Go forward to a next chapter, section or similar marker in the media. none previousTrack none true Go back to a previous chapter, section or similar marker in the media. Table 5.3.1.65-2: DataPoints of playerControl ModuleClass Name Type R/W Optional Unit Documentation currentPlayerMode hd:enumPlayerMode RW false The current mode of the player. currentPlayerModeName xs:string R true Name of current player mode in string. This can be used when "currentPlayerMode" is vendor- specific. supportedPlayerModes list of hd:enumPlayerMode R false List of supported modes for a player. speedFactor xs:float RW true The optional factor of speeding up or slowing down playback, rewind or fast forward.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.66 powerSave
|
This ModuleClass provides capabilities to enable the power saving mode of a device and monitor the current status. Table 5.3.1.66-1: DataPoints of powerSave ModuleClass Name Type R/W Optional Unit Documentation powerSaveEnabled xs:boolean RW false The current status of the power saving mode. "True" indicates enabled, and "False" indicates not enabled.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.67 printQueue
|
This ModuleClass provides the capabilities for monitoring printing list information. Table 5.3.1.67-1: DataPoints of printQueue ModuleClass Name Type R/W Optional Unit Documentation uri list of xs:uri trueR false The URI of the printing file. The URI could be "file://www.example.com/file.extension". printingState list of hd:enumJobState R false The printingState is indicating the status of the printing file.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.68 pulsemeter
|
This ModuleClass provides the capability to report the measurement of pulse characteristics. Table 5.3.1.68-1: DataPoints of pulsemeter ModuleClass Name Type R-W Optional Unit Documentation pulseRate xs:float R false bpm The measurement of pulserate by pulsemeter. rr xs:float R true ms The measurement of RR interval by pulsemeter. energy xs:float R true kcal/h The measurement of energy by pulsemeter. modality xs:string R true The modality of a particular SpO2 measurement. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 40 oneM2M TS-0023 version 4.8.1 Release 4
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.69 pushButton
|
This ModuleClass provides the capability to indicate the operation of a push button style switch. A typical application can be an SOS button. Table 5.3.1.69-1: DataPoints of pushButton ModuleClass Name Type R/W Optional Unit Documentation pushed xs:boolean R false This data point indicates the press of the button.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.70 recorder
|
This ModuleClass provides the capability to record video/audio for a defined duration. Table 5.3.1.70-1: DataPoints of recorder ModuleClass Name Type R/W Optional Unit Documentation duration xs:integer RW false s The duration for video/audio recording. Set to trigger the recorder.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.71 refrigeration
|
This ModuleClass provides capabilities for a refrigeration function. Table 5.3.1.71-1: DataPoints of refrigeration ModuleClass Name Type R/W Optional Unit Documentation rapidFreeze xs:boolean RW true Controls the rapid freeze capability. "True" indicates active, "False" indicates inactive. rapidCool xs:boolean RW true Controls the rapid cool capability. "True" indicates active, "False" indicates inactive. defrost xs:boolean RW true Controls the defrost cycle. "True" indicates active, "False" indicates inactive. deodorize xs:boolean RW true Controls the deodorize cycle. "True" indicates active, "False" indicates inactive. degerm xs:boolean RW true Controls the degerm cycle. "True" indicates active, "False" indicates inactive.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.72 relativeHumidity
|
This ModuleClass provides the capability for a device to report the humidity based on a specified rule that is vendor dependent. Table 5.3.1.72-1: DataPoints of relativeHumidity ModuleClass Name Type R/W Optional Unit Documentation relativeHumidity xs:float R false pct The measurement of the relative humidity value. desiredHumidity xs:float RW true Desired value for humidity. This data point indicates the desired humidity.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.73 remoteControlEnable
|
This ModuleClasses provides capabilities to monitor the remote controllability of the appliance. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 41 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.73-1: DataPoints of remoteControlEnable ModuleClass Name Type R-W Optional Unit Documentation remoteControlEnabled xs:boolean R false This data point enables or disables remote controllability and is set by a user locally. "True" indicates enabled remote access, and "False" indicates disabled remote access.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.74 robotCleanerJobMode
|
This ModuleClasses provides capabilities to control and monitor the job modes of a robotCleaner. Table 5.3.1.74-1: DataPoints of robotCleanerJobMode ModuleClass Name Type R/W Optional Unit Documentation currentJobMode hd:enumRobotCleanerJobMode RW false Currently active job mode (see clause 5.6.28). currentJobModeName xs:string R true Name of current job mode as a string. This can be used when "currentJobMode" is vendor-specific. jobModes list of hd:enumRobotCleanerJobMode R false List of possible job states the device supports (see clause 5.6.28).
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.75 runState
|
This ModuleClasses provides capabilities to control and the monitor machine state of appliances. Table 5.3.1.75-1: DataPoints of runState ModuleClass Name Type R/W Optional Unit Documentation currentMachineState hd:enumMachineState RW false The currently active machine state (see clause 5.6.25). machineStates list of hd:enumMachineState R false A list of possible machine states the device supports (see clause 5.6.25). currentJobState hd:enumJobState R true The currently active job state at the level of some transaction being executed by the device (see clause 5.6.23). jobStates list of hd:enumJobState R true The list of possible job states that the device supports (see clause 5.6.23). progressPercentage xs:float R true The indication of current job progress in percentage.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.76 securityMode
|
This ModuleClasses provides capabilities to control and monitor a security mode. Table 5.3.1.76-1: DataPoints of securityMode ModuleClass Name Type R/W Optional Unit Documentation currentSecurityMode hd:enumSecurityMode RW false Current security mode (see clause 5.6.29). securityModes list of hd:enumSecurityMode R false List of possible security modes the device supports (see clause 5.6.29). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 42 oneM2M TS-0023 version 4.8.1 Release 4
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.77 sessionDescription
|
This ModuleClass provides the capabilities for a sessionDescription containing a URL at which the specified media can be accessed and the definition of media using SDP. Table 5.3.1.77-1: DataPoints of mediaType ModuleClass Name Type R/W Optional Unit Documentation url xs:uri R true A URL at which the specified media can be accessed. sdp xs:string R true Media description using SDP. One or more comma separated multiple SDP lines (SDP media or attribute line) can be included using SDP description syntax as defined in the SDP specification in IETF RFC 4566 [16].
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.78 signalStrength
|
This ModuleClass provides the capability to monitor the strength of the signal. Table 5.3.1.78-1: DataPoints of signalStrength ModuleClass Name Type R/W Optional Unit Documentation lqi xs:integer truR false The current value of link quality indicator, which reflects the scaling of rssi by dividing the received signal strength over reference signal strength. The common unit for lqi is percentage [0,100]. For the detailed definition, see IEEE 802.15.4 [i.4], clause 6.7.8. rssi xs:float R true The current value of received signal strength indicator, which reflects the raw signal level.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.79 slcAlarm
|
This ModuleClass provides capabilities to provide alarm information of street light controller. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 43 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.79-1: DataPoints of slcAlarm ModuleClass Name Type R/W Optional Unit Documentation overCurrentThreshold xs:float RW true A The threshold of over current. overCurrentDuration xs:integ er RW true min The duration of over current to trigger the alarm. underCurrentThreshol d xs:float RW true A The threshold of under current. underCurrentDuration xs:integ er RW true min The duration of under current to trigger the alarm. overVoltageThreshold xs:float RW true V The threshold of over voltage. overVoltageDuration xs:integ er RW true min The duration of over voltage to trigger the alarm. underVoltageThreshol d xs:float RW true V The threshold of under voltage. underVoltageDuration xs:integ er RW true min The duration of under voltage to trigger the alarm. overVoltagePercent xs:integ er RW true pct The threshold of over current in terms of percentage. The value range is [0,100]. This is the alternative trigger of the overVoltageAlarm and should be mutually exclusive to the overVoltageThreshold. underVoltagePercent xs:integ er RW true pct The duration of under current in terms of percentage. The value range is [0,100]. This is the alternative trigger of the underVoltageAlarm and should be mutually exclusive to the underVoltageThreshold. standardreferenceVolt age xs:float RW true V The reference voltage used as the basis of the overVoltagePercent and underVoltagePercent. overCurrentAlarm xs:boole an R false The alarm of over current. underCurrentAlarm xs:boole an R false The alarm of under current. overVoltageAlarm xs:boole an R false The alarm of over voltage. underVoltageAlarm xs:boole an R false The alarm of under voltage.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.80 slcParameterSetting
|
This ModuleClass provides capabilities to set service parameters. Table 5.3.1.80-1: DataPoints of slcParameterSetting ModuleClass Name Type R/W Optional Unit Documentation lightCount xs:integer RW true Number of lampholders controlled by the street light controller. timePlanStatus xs:boolean RW true "False" indicates the time plan is not used. "True" indicates the time plan is being used. timeRangeCount xs:integer RW true The number of time ranges for the time plan. timeRange list of xs:time RW true An array of sequential time points which define the time plan. Each time point is the start time of the next time range as well as the end of previous time range in the time plan. timeRangeLightDim mingValue list of xs:string RW true An array containing the dimming values in different time ranges. In the case that lightCount is larger than 1, it is a 2-dimentional array describing the dimming value of each lampholder in each time range.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.81 slcReportInfo
|
This ModuleClass provides information of status of the street light controller. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 44 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.81-1: DataPoints of slcReportInfo ModuleClass Name Type R/W Optional Unit Documentation voltageFrequency xs:float R true Hz The frequency of voltage. switchStatus xs:boolean RW false This value indicates the status of light switch. "False": off, "True": on. onlineStatus xs:boolean R true This value indicates the communication status of light. "False": offline, "True": online. lightVoltage xs:float R false V The voltage of the street light controller. lightCurrent xs:float R false A The current of the street light controller. lightDimmingValue xs:integer RW false % The dimming value of the street light. lightPowerFactor xs:float R false The light power factor is the ratio of active power to apparent power. Power factor is a factor that measures the efficiency of electrical equipment. The value range is [0,1]. lightActivePower xs:float R true kW Active power is the electrical power required to keep the electrical equipment running normally, that is, the electrical power that converts electrical energy into other forms of energy, such as mechanical, optical, thermal, and so on. lightReactivePower xs:float R true kVA The reactive power is the electrical power required to establish an alternating magnetic field and induced magnetic flux. lightApparentPower xs:float R true kVA This value indicates the apparent power that is mainly used to calculate the energy consumption of the street light. lightPolarizationAxis xs:float R true degree The angle of the polarization axis in case street light devices support this feature. colourTemperature xs:integer R true K The current colour temperature of the street lights. lampTechnology xs:string R true A string that indicates the type of lamp technology that is used in the street lamps, e.g. "LED", "Tungsten", etc.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.82 smokeSensor
|
This ModuleClass provides the capabilities to indicate the detection of smoke and raising an alarm if the triggering criterion is met. Table 5.3.1.82-1: Actions of smokeSensor ModuleClass Return Type Name Argument Optional Documentation none mute none true Mute the smoke sensor alarm. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 45 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.82-2: DataPoints of smokeSensor ModuleClass Name Type R-W Optional Unit Documentation alarm xs:boolean R false The alarm is indicated as follows: "True" indicates that smoke has been detected, "False" indicates a normal status, that means that smoke is not detected. detectedTime m2m:timestamp RW true The date and time the smoke is detected. smokeThreshhold xs:integer RW true ppm The threshhold to trigger the alarm. currentValue xs:integer R true The current data value of the smoke sensor. sensorFault xs:boolean R true "True" indicates the sensor fault status of smoke sensor. "False" indicates the sensor fault of smoke sensor has been eliminated. lowVoltage xs:boolean R true "True" indicates the low voltage status of smoke sensor. "False" indicates the low voltage alarm of smoke sensor has been eliminated. dismantled xs:boolean R true "True" indicates the smoke sensor is dismantled. "False" indicates the dismantled alarm of smoke sensor has been eliminated. powerOn xs:boolean R true "True" indicates the smoke sensor is powered on. "False" is invalid.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.83 sphygmomanometer
|
This ModuleClass provides the capability to report the measurement of blood pressure characteristics. Table 5.3.1.83-1: DataPoints of sphygmomanometer ModuleClass Name Type R-W Optional Unit Documentation diastolicPressure xs:float R false mmHg The measurement of diastolic pressure by sphygmomanometer. systolicPressure xs:float R false mmHg The measurement of systolic pressure by sphygmomanometer. meanPressure xs:float R false mmHg The measurement of mean arterial pressure by sphygmomanometer.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.84 spinLevel
|
This ModuleClass provides capabilities to control and monitor the level of spin. It is intended to be part of devices which use spinning function such as a washing machine and a dryer. Table 5.3.1.84-1: DataPoints of spinLevel ModuleClass Name Type R/W Optional Unit Documentation spinLevelStrength hd:enumSpinLevelStrength RW false The value of spin-dry level (see clause 5.6.30). A higher value indicates a higher spin level.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.85 steamClosetJobMode
|
This ModuleClasses provides capabilities to control and monitor the job modes of steamCloset. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 46 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.85-1: DataPoints of steamClosetJobMode ModuleClass Name Type R/W Optional Unit Documentation currentJobMode hd:enumSteamClosetJobMode RW false Currently active job mode (see clause 5.6.31). currentJobModeName xs:string R true Name of current job mode as a string. This can be used when "currentJobMode" is vendor-specific. jobModes list of hd:enumSteamClosetJobMode R false List of possible job states the device supports (see clause 5.6.31).
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.86 televisionChannel
|
This ModuleClass provides capabilities to set and get channels of a device that has a channel list. Table 5.3.1.86-1: Actions of televisionChannel ModuleClass Return Type Name Argument Optional Documentation none upChannel None true Change the current channel to the next channel in the stored list of available channels. If the current channel is the last one in the list, the new set channel may be the first one in the list. none downChannel None true Change the current channel to the previous channel in the stored list of available channels. If the current channel is the first one in the list, the new set channel may be the last one in the list. Table 5.3.1.86-2: DataPoints of televisionChannel ModuleClass Name Type R/W Optional Unit Documentation channelNumber xs:integer RW false Current channel number. availableChannels list of xs:integer R true The list of available channel numbers which may be build by automatic scan and/or manual selection. previousChannel xs:integer R true The channel number which was selected previously. channelName xs:string R true Current human-friendly channel name in string, for example 'CNN'.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.87 temperature
|
This ModuleClass provides capabilities to represent the current temperature and target temperature of devices such as an air conditioner, refrigerator, oven, etc. Table 5.3.1.87-1: DataPoints of temperature ModuleClass Name Type R/W Optional Unit Documentation currentTemperature xs:float R false The current temperature. targetTemperature xs:float RW true The desired temperature to reach. unit hd:enumTemperatureUnit RW true C or F or K Default values is 'C'. minValue xs:float R true Minimum value of "targetTemperature". maxValue xs:float R true Maximum value of "targetTemperature". stepValue xs:float R true Step value allowed for "targetTemperature".
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.88 temperatureAlarm
|
This ModuleClass provides the capabilities to indicate the detection of abnormal temperatures and raises an alarm if the triggering criterion is met. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 47 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.88-1: DataPoints of temperatureAlarm ModuleClass Name Type R/W Optional Unit Documentation unit hd:enumTemperatureUnit RW true C or F or K Default value is 'C'. temperature xs:float R true Defined in the datapoint 'unit' To report the value of the temperature. highTemperatureAlarm xs:boolean R false High temperature alarm. highTemperatureAlarmThreshold xs:float RW true Defined in the datapoint 'unit' The threshold of maximum temperature alarm. lowTemperatureAlarm xs:boolean R false Low temperature alarm. lowTemperatureAlarmThreshold xs:float RW true Defined in the datapoint 'unit' The threshold of minimum temperature alarm. alarmTimestamp xs:datetime R true The timestamp since the alarm is active.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.89 textMessage
|
This ModuleClass provides capabilities to set and get a text message. Table 5.3.1.89-1: Actions of textMessage ModuleClass Return Type Name Argument Optional Documentation none resetTextMessage none true Reset the receiver of the message to the "defaultValue". Table 5.3.1.89-2: DataPoints of textMessage ModuleClass Name Type R/W Optional Unit Documentation textMessage xs:string RW false The current message value. supportedMessageValues list of xs:string R true List of supported values for the message. Each of the values in this list shall be URL-encoded. An encoded value shall not contain white spaces. minLength xs:integer R true The optional minimum length in characters of the message. The default is 0. maxLength xs:integer R true The optional maximum length in characters of the message. The default is unlimited. messageEncoding xs:string R true The optional expected method for character encoding of the message. The default is "UTF-8". defaultValue xs:string RW true The optional default value for "textMessage". The default is an empty string.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.90 timer
|
This ModuleClass provides capabilities to monitor and control the times when the appliance executes its operations, that means when it starts, when it ends, etc. Table 5.3.1.90-1: Actions of timer ModuleClass Return Type Name Argument Optional Documentation none activateClockTimer None true Activate current clock timer. none deactivateClockTimer None true Deactivate current clock timer. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 48 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.90-2: DataPoints of timer ModuleClass Name Type R/W Optional Unit Documentation referenceTimer xs:integer R true A timer (for example. a time-based value, App Defined Epoch, Progressive) expressed in seconds. The value indicates a time counter to be used as reference for the other time-based data points of this ModuleClass. Usually it is the time since the last event of power-on of the producer (or more in detail the time since the boot of its connectivity node). targetTimeToStart xs:integer RW true A time span (for example a time-based value, App Defined Epoch, Fixed) expressed in seconds. The value indicates the time when the appliance is expected to start its operation, starting counting from the last "referenceTimer". targetTimeToStop xs:integer RW true A time span (for example a time-based value, App Defined Epoch, Fixed) expressed in seconds. The value indicates the time when the appliance is expected to stop its operation, starting counting from the last "referenceTimer". estimatedTimeToEnd xs:integer R true A timer (for example a time-based value, App Defined Epoch, Progressive) expressed in seconds. The value indicates the time to the end of an appliance's operations. It is calculated at runtime by the device itself during the execution of its operation. runningTime xs:integer R true A timer (for example a time-based value, App Defined Epoch, Progressive) expressed in seconds. It indicates the time of the current operation. Usually its value is increasing one value per second. It starts counting from 0 when the operation starts and stops counting when the operation ends. targetDuration xs:integer R true A time span (for a time-based value, App Defined Epoch, Fixed) expressed in seconds. The value indicates a time that represents the target duration of the operation as per user selection. absoluteStartTime m2m:timestamp RW true An absolute time to specify the start time. absoluteStopTime m2m:timestamp RW true An absolute time to specify the stop time.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.91 turbo
|
This ModuleClass provides capabilities to enable turbo mode and monitor the current status of the turbo function. It is intended to be part of devices which use turbo function such as an air conditioner, a washing machine, etc. Table 5.3.1.91-1: DataPoints of turbo ModuleClass Name Type R/W Optional Unit Documentation turboEnabled xs:boolean RW false The current status of the turbo mode. "True" indicates enabled, and "False" indicates not enabled.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.92 uvSensor
|
This ModuleClass describes the capabilities of an ultraviolet sensor. Table 5.3.1.92-1: DataPoints of uvSensor ModuleClass Name Type R/W Optional Unit Documentation uvValue xs:float R false mW/cm2 uvStatus hd:enumUvStatus R true The "uvStatus" indicates the level of the UV radiation status (see clause 5.6.35). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 49 oneM2M TS-0023 version 4.8.1 Release 4
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.93 waterFlow
|
This ModuleClass provides capabilities for controlling the water strength of a device. Table 5.3.1.93-1: DataPoints of waterFlow ModuleClass Name Type R/W Optional Unit Documentation waterLevelStrength hd:enumWaterFlowStrength RW false The desired level of water flow (see clause 5.6.37). A higher value indicates higher water flow.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.94 waterMeterAlarm
|
This ModuleClass provides capabilities to provide alarm information of watermeter, such as the alarm of low water flow. Once an alarm is fired, a notification should be sent out from the device and no historical alarm is stored locally, therefore no need to associate timestamp with the alarms. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 50 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.94-1: DataPoints of waterMeterAlarm ModuleClass Name Type R/W Optional Unit Documentation highFlowAlarmThreshold xs:float RW false m3 The threshold of continuous high flow alarm. highFlowDuration xs:integer RW true s The duration of high water flow. highFlowAlarm xs:boolean R false Continuous high water flow alarm. lowFlowAlarmThreshold xs:float RW true m3 The threshold of continuous low flow alarm. lowFlowDuration xs:integer RW true s The duration of low water flow. lowFlowAlarm xs:boolean R true Continuous low water flow alarm. reverseFlowAlarmThreshold xs:float RW true m3 The threshold of continuous reverse flow alarm. reverseFlowDuration xs:integer RW true s The duration of reverse water flow. reverseFlowAlarm xs:boolean R false Reverse flow alarm. highPressureAlarmThreshol d xs:float RW false bar The threshold of high water pressure alarm. highPressureAlarm xs:boolean R false High water pressure alarm. lowPressureAlarmThreshold xs:float RW false bar The threshold of low water pressure alarm. lowPressureAlarm xs:boolean R false Low water pressure alarm. highTemperatureAlarmThre shold xs:float RW false C The threshold of maximum water temperature alarm. highTemperatureAlarm xs:boolean R false High water temperature alarm. lowTemperatureAlarmThres hold xs:float RW false C The threshold of minimum water temperature alarm. lowTemperatureAlarm xs:boolean R false Low water temperature alarm. highTemperatureInnerAlarm Threshold xs:float RW true C The threshold of high temperature alarm inside water meter. innerHighInternalTemperatu reAlarm xs:boolean R true Internal high temperature alarm. innerErrorAlarm xs:boolean R true Internal error alarm. innerTemperatureSensorFa ult xs:boolean R true Internal temperature sensor failure. tamperAlarm xs:boolean R true Data was tampered alarm. waterTemperatureSensorFa ult xs:boolean R false Water temperature sensor failure. pressureSensorFault xs:boolean R true Pressure sensor failure. communicationAlarm xs:boolean R true Communication abnormality alarm. magneticInterference xs:boolean R true Magnetic interference warning. storageFault xs:boolean R true Storage failure alarm. urgencyButtonPush xs:boolean R true Indicate the event of the urgency button being pushed. Pushing the urgency button may give a user a temporary right to still use the water meter (e.g. for 3 days) after an unpaid bill. buttonFault xs:boolean R true Button error flag. demolitionAlarm xs:boolean R true Demolition sign. impulseFault xs:boolean R true Pulse anomaly flag. vibrationSensorFault xs:boolean R true Vibration sensor failure.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.95 waterMeterReportInfo
|
This ModuleClass provides information of measurements of the watermeter. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 51 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.95-1: DataPoints of waterMeterReportInfo ModuleClass Name Type R/W Optional Unit Documentation dailyUseWaterTime xs:integer R true s The total time of water consumption daily. cumulativeFlow xs:float R false m3 The total consumption of water(since the activation of the meter). cumulativeFlowDaily xs:float R true m3 The cumulative daily consumption of water (begins at 00:00). positiveCumulativeFlo w xs:float R true m3 The positive cumulative consumption of water daily (begins at 00:00). negativeCumulativeFl ow xs:float R true m3 The negative cumulative consumption of water daily (begins at 00:00). peakFlowRate xs:float R true m3/h Daily maximum instantaneous water flow rate. peakFlowRateTime m2m:timesta mp R true The timestamp of the daily highest instantaneous water flow rate. lowestFlowRate xs:float R true m3/h Daily lowest instantaneous water flow rate. lowestFlowRateTime m2m:timesta mp R true The timestamp of daily lowest instantaneous water flow rate. peakReverseFlowRat e xs:float R true m3/h Daily reverse maximum instantaneous water flow rate. peakReverseFlowRat eTime m2m:timesta mp R true The timestamp of daily reverse highest instantaneous water flow rate. lowestReverseFlowR ate xs:float R true m3/h Daily reverse lowest instantaneous water flow rate. lowestReverseFlowR ateTime m2m:timesta mp R true The timestamp of daily reverse lowest instantaneous water flow rate. intervalFlow list of xs:float R true m3 Water consumption records measured at the interval of "flowInterval" described in clause 5.3.1.96 per day. reverseIntervalFlow list of xs:float R true m3 Water reverse consumption records measured at the interval of "reverseFlowInterval" described in clause 5.3.1.96 per day. waterIntervalTempera ture list of xs:float R true C Water temperature records measured at the interval of "waterTemperatureInterval" described in clause 5.3.1.96 per day. waterIntervalPressure list of xs:float R true bar Water pressure records measured at the interval of "waterPressureInterval" described in clause 5.3.1.96 per day.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.96 waterMeterSetting
|
This ModuleClass provides capabilities to set service parameters for data sampling and reporting. Table 5.3.1.96-1: DataPoints of waterMeterSetting ModuleClass Name Type R/W Optional Unit Documentation flowInterval xs:integer RW false s The measurement interval of water consumption. reverseFlowInterval xs:integer RW false s The measurement interval of reverse water consumption. waterTemperatureIn terval xs:integer RW true s The measurement interval of water temperature. waterPressureInterv al xs:integer RW true s The measurement interval of reverse water pressure. intensiveSampleInte rval xs:integer RW true s The time interval of intensive data sampling. intensiveReportInter val xs:integer RW true s The time interval of intensive data report. intensiveReportStart Time m2m:timesta mp RW true The start time of data intensive report.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.97 waterSensor
|
This ModuleClass provides the capabilities to indicate whether or not water has been sensed, and raising an alarm if the triggering criterion is met. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 52 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.97-1: DataPoints of waterSensor ModuleClass Name Type R/W Optional Unit Documentation alarm xs:boolean R false The detection of water. The alarm is indicated as follows: • "True" indicates that water has been detected. • "False" indicates a normal status, that means that water is not detected.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.98 waterQualityMonitor
|
This ModuleClass provides the information of water quality detection. Table 5.3.1.98-1: DataPoints of waterQualityMonitor ModuleClass Name Type R/W Optional Unit Documentation algae xs:float R true mg/L Blue-green algae anionics xs:float R true mg/L An-ionic surfactant aroh xs:float R true mg/L Volatile phenol (ArOH) as xs:float R true mg/L Arsenic (As) biotoxicity xs:float R true mg/L Biological toxicity bod xs:float R true mg/L Biochemical oxygen demand (BOD) is the amount of dissolved oxygen consumed during the biochemical reaction of biodegradable organic matter that is decomposed by microorganisms in water under certain conditions. cod xs:float R true mg/L Chemical oxygen demand (COD) is the amount of reducing substance that needs to be oxidized in a water sample. conductivity xs:float R true S/m (siemens per meter) Conductivity is a parameter used to describe the ease of charge flow in a substance. cd xs:float R true mg/L Cadmium (Cd) chlorophyll_a xs:float R true mg/L Chlorophyll a cn xs:float R true mg/L Cyanide (CN) cr6 xs:float R true mg/L Hexavalent chromium (Cr6) cu xs:float R true mg/L Cuprum (Cu) do xs:float R true mg/L Dissolved oxygen (DO). Molecular oxygen in the air dissolved in water is called dissolved oxygen. f xs:float R true mg/L Fluoride (F) fe xs:float R true mg/L Total iron (Fe) ftu xs:float R true mg/L Turbidity (FTU) which refers to degree of hindrance of the solution as the light passes through it. hg xs:float R true mg/L Mercury (Hg) kmno4 xs:float R true mg/L Permanganate index which refers to the amount of oxidant consumed in the water samples using potassium permanganate as an oxidant in an acidic or alkaline medium. (KMnO4). nh3nh4 xs:float R true mg/L Ammonia nitrogen (NH3NH4) is the nitrogen in the form of free ammonia (NH3) and ammonium ions (NH4+) in water. no3n xs:float R true mg/L Nitrate nitrogen (NO3N) oil xs:float R true mg/L Petroleum pollutants pb xs:float R true mg/L Lead (Pb) ph xs:float R true Potential Of Hydrogen (pH) sulfide xs:float R true mg/L Sulfide temperature xs:float R true C Water temperature ETSI ETSI TS 118 123 V4.8.1 (2024-02) 53 oneM2M TS-0023 version 4.8.1 Release 4 Name Type R/W Optional Unit Documentation tn xs:float R true mg/L Total nitrogen (TN) which is defined as the total amount of various forms of inorganic and organic nitrogen in water. tp xs:float R true mg/L Total phosphorus (TP) which is the result of the conversion of various forms of phosphorus into orthophosphate after digestion of the water sample, measured in milligrams of phosphorus per liter of water sample. zn xs:float R true mg/L Zinc (Zn)
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.99 weight
|
This ModuleClass provides the capability to report the measurement of weight. Table 5.3.1.99-1: DataPoints of weight ModuleClass Name Type R/W Optional Unit Documentation weight xs:float R false kg The weight measurement. unit hd:enumWeightUnit RW true The unit of measure for the weight values. The default is kilogram (kg) (see clause 5.6.5).
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.100 anemometer
|
This ModuleClass provides the capabilities to indicate the measure of the wind speed. Table 5.3.1.100-1: DataPoints of anemometer ModuleClass Name Type R/W Optional Unit Documentation speed xs:float R false km/h The speed of the wind
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.101 barometer
|
This ModuleClass provides the capabilities to measure the atmospheric pressure and indicate the detection of abnormal pressure, and raise an alarm if a triggering criterion is met. Table 5.3.1.101-1: DataPoints of barometer ModuleClass Name Type R/W Optional Unit Documentation alarm xs:boolean R true This data point indicates the status of detection of an abnormal pressure. "True" indicates an abnormal pressure, "False" indicates a normal pressure. atmosphericPressure xs:float R false hPa To report the value of the atmospheric pressure. minPressureThreshold xs:integer RW true hPa The min threshold to trigger the alarm. maxPressureThreshold xs:integer RW true hPa The max threshold to trigger the alarm.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.102 rainGauge
|
This ModuleClass provides the capabilities to measure the height of fallen rain. Table 5.3.1.102-1: Actions of rainGauge ModuleClass Return Type Name Argument Optional Documentation none reset none false Empty the water container. Set the height value to 0. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 54 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.102-2: DataPoints of rainGauge ModuleClass Name Type R/W Optional Unit Documentation height xs:integer R false mm This data point indicates the number of mm of rainfall since the last reset of the device.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.103 infraredSensor
|
This ModuleClass provides the capabilities to indicate whether or not an object has been sensed. Table 5.3.1.103-1: DataPoints of infraredSensor ModuleClass Name Type R/W Optional Unit Documentation detectedValue xs:boolean R false The "detectedValue" indicates as follows: "True" means that an object is detected, "False" means no object is detected. detectedTime m2m:timestamp R false The time when the object was detected.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.104 disposal
|
This ModuleClass provides capabilities to control the status of the disposing functionality for garbage disposal. Table 5.3.1.104-1: DataPoints of disposal ModuleClass Name Type R/W Optional Unit Documentation disposalStatus xs:boolean RW false The status of disposal. "True" indicates disposing, "False" indicates not disposing.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.105 waterFilterType
|
This ModuleClass indicates the type of the water purifier. Table 5.3.1.105-1: DataPoints of waterFilterType ModuleClass Name Type R/W Optional Unit Documentation filterType hd:enumWaterFilterType R false The type of water purifier. list of Water Filter Type (see clause 5.6.41).
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.106 touchScreen
|
This ModuleClass provides the capability to get selections of a user from the pre-defined menus on the screen as parts of a process of charging transportation payment card of the user. Table 5.3.1.106-1: DataPoints of touchScreen ModuleClass Name Type R/W Optional Unit Documentation pushed xs:boolean R false This data point indicates the press of the button. (1..N) positionX xs:integer R false pixel This data point indicates the horizontal position of the touching (1..N) positionY xs:integer R false pixel This data point indicates the vertical position of the touching. (1..N)
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.107 prePaidCardReader
|
The Pre-paid card reader ModuleClass provides functions to read NFC card and indicates its information. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 55 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.107-1: DataPoints of prePaidCardReader ModuleClass Name Type R/W Optional Unit Documentation readStatus xs:boolean R false This data point indicates the status of reading the pre-paid card. "True" means the reader reads the pre-paid card successfully. cardInfo xs:integer R false The card information is consisted of numbers of integer values (1..N). balance xs:float RW false This data point indicates the balance of the pre-paid card. currency xs:string R true The currency is depended on the country which the card is used. For example, the unit could be "Dollar" or "$" in US, "Euro" in EU and "Won" in Korea.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.108 billDeposit
|
This ModuleClass provides the capability to deposit bills, indicates the balance of the deposited bills and detects fake. Table 5.3.1.108-1: DataPoints of billDeposit ModuleClass Name Type R/W Optional Unit Documentation depositStatus xs:boolean R false This data point indicates the deposit is made successfully or not. balance xs:float R false This data point indicates the balance of the deposited bills. count xs:integer R false The data point indicates the number of bills which are deposited [1..N]. currency xs:string R true The currency is depended on the country which the deposited bills are used. For example, the currency could be "Dollar" in US, "Euro" in EU and "Won" in Korea. fakeStatus xs:boolean R false This data point indicates that the deposited bills are fake notes.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.109 billWithdrawal
|
This ModuleClass provides the capability to withdraw bills which are deposited by the billDepositModule. Table 5.3.1.109-1: DataPoints of billWithdrawal ModuleClass Name Type R/W Optional Unit Documentation withdrawalStatus xs:boolean R false This data point indicates the withdrawal is made successfully or not. balance xs:float R false This data point indicates the balance of the withdrawn bills. count xs:integer R false The data point indicates the number of bills which are withdrawn [1..N].
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.110 coinDeposit
|
This ModuleClass provides the capability to deposit coins, indicates the balance of the deposited coins and detects fake. Table 5.3.1.110-1: DataPoints of coinDeposit ModuleClass Name Type R/W Optional Unit Documentation depositStatus xs:boolean R false This data point indicates the deposit is made successfully or not. balance xs:float R false This data point indicates the balance of the deposited coins. count xs:integer R false The data point indicates the number of coins which are deposited. currency xs:string R true The currency is depended on the country that the deposited coins are used. For example, the unit could be "Dollar" in US, "Euro" in EU and "Won" in Korea. fakeStatus xs:boolean R false This data point indicates that the deposited coins are fake. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 56 oneM2M TS-0023 version 4.8.1 Release 4
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.111 cashDispenser
|
This ModuleClass provides the capability to withdraw designated amount of cash or returns all the deposited bills and coins by the billDepositModule and coinDepositModule. Table 5.3.1.111-1: DataPoints of cashDispenser ModuleClass Name Type R/W Optional Unit Documentation dispenseStatus xs:boolean R false This data point indicates the dispense is successful or not. balance xs:float R false This data point indicates the balance of the dispensed bills and coins. count xs:integer R false The data point indicates the number of bills and coins which are dispensed. currency xs:string R true The currency is depended on the country that the dispensed bills and coins are used. For example, the unit could be "Dollar" in US, "Euro" in EU and "Won" in Korea.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.112 cardScanner
|
This ModuleClass provides the capability to scan an image of a card, gets the card information from the image and provides the information. Table 5.3.1.112-1: DataPoints of cardScanner ModuleClass Name Type R/W Optional Unit Documentation scanStatus xs:boolean R false This data point indicates the scanning process is successful. cardInfo xs:integer R false The card information is consisted of numbers of integer values (1..N).
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.113 traceSensor
|
This ModuleClass provides the capabilities to indicate the heading (e.g. status of get-in and get-out) of a pedestrian or a vehicle which crossing a control point (e.g. entrance and gate). Table 5.3.1.113-1: DataPoints of traceSensor ModuleClass Name Type R/W Optional Unit Documentation heading xs:float RW true The azimuth of a device measured in degrees to true north. North is 0,0 degrees, east is 90,0 degrees, south is 180,0 degrees, west is 270,0 degrees. A negative value indicates an unknown heading. headingAccuracy xs:float R true deg The optional current maximum deviation between the heading and the true geomagnetic heading.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.114 directionPanel
|
This ModuleClass displays a signal (e.g. direction arrow) to indicate a gate is permitted to get-in or get-out on a panel. Table 5.3.1.114-1: DataPoints of directionPanel ModuleClass Name Type R/W Optional Unit Documentation direction xs:boolean RW false The direction is true, the panel indicates go forward signal or icon. If the direction is false, the panel displays stop signal or icon.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.115 crossingBarrier
|
An active barrier is used to block a pedestrian or vehicle from a control point (e.g. entrance and gate). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 57 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.3.1.115-1: DataPoints of crossingBarrier ModuleClass Name Type R/W Optional Unit Documentation barrierDefault xs:boolean RW true The value of the barrier default is true, the default status of the barrier is closed and vice versa. barrierStatus xs:boolean RW false The value of the barrier status is true, the barrier is closed and vice versa. timer xs:time RW true The timer indicates the duration of barrierStatus is changed. This means that barrierStatus is set to the current value of barrierDefault.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.116 3DDisplay
|
This ModuleClass provides capabilities to give the information of a 3D display. Table 5.3.1.116-1: DataPoints of 3DDisplay ModuleClass Name Type R/W Optional Unit Documentation 3DDisplayType cod:enum3DDisplayType R false The type of 3D display technology (see clause 5.6.52) 3DDisplayViewAngle xs:integer R true degree This data point indicates viewing angle of the 3D display (1..360) 3DDisplayResolutionX xs:integer R true This data point indicates resolution of X-axis of the 3D display. 3DDisplayResolutionY xs:integer R true This data point indicates resolution of Y-axis of the 3D display. 3DGlasses xs:boolean R true This data point indicates the 3D display uses 3D glasses (TRUE) or not.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.1.117 3DScanner
|
This ModuleClass provides the capability to scanning 3D object for the user. Table 5.3.1.117-1: DataPoints of 3DScanner ModuleClass Name Type R/W Optional Unit Documentation 3DScannerType cod:enum3DScannerType R false This data point indicates type of the 3D scanner. 3DScanResolution xs:integer R false dpi This data point indicates the scanning resolution. maxSizeX xs:float R true cm This data point indicates the maximum horizontal size of the scanning. maxSizeY xs:float R true cm This data point indicates the maximum vertical size of the scanning. maxSizeZ xs:float R true cm This data point indicates the maximum depth of the scanning.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.2 City Domain
|
For further study.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.3 Health Domain
|
For further study.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.4 Home Domain
|
For further study. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 58 oneM2M TS-0023 version 4.8.1 Release 4
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.5 Industry Domain
|
For further study.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.6 Vehicular Domain
|
For further study.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.7 Agriculture Domain
| |
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.7.1 cowActivityMonitor
|
This ModuleClass provides capabilities to measure activity data in terms of step count. The data sampling rate is every hour by default. Table 5.3.7.1-1: DataPoints of cowActivityMonitor ModuleClass Name Type R/W Optional Unit Documentation stepsPerPeriod list of xs:integer R false Counted steps per hour during each report period. The value is updated every report period. The length of the report period can be configured by the periodicalReportConfig ModuleClass. If not configured, the default length of the period is 1 hour. If the report period is longer than 1 hour, this data point may contain multiple data samples (one for each hour) during last period. The report period should always be set to longer than 1 hour which is the data sampling period. The start time of the data sampling and report period is implementation specific, e.g. the power-on time. updateTime xs:datetime R true A timestamp that indicates the update time of the stepsPerPeriod data point. historyStepCounts list of xs:integer R false The list of stepCounts per hour during the last 24 hours (in total 24 data samples).
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.8 Railway Domain
| |
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.3.8.1 baliseTransmissionModule
|
A balise is an electronic beacon or transponder placed between the rails of a railway as part of an Automatic Train Protection (ATP) system. The Balise Transmission Module (BTM) ModuleClasses provides capabilities to indicate and to get balise information. Table 5.3.8.1-1: DataPoints of baliseTransmissionModule ModuleClass Name Type R/W Optional Unit Documentation baliseSystemId hd:enumBaliseSystemIndicator R true Get the hd:enumBaliseSystemIndicator (see clause 5.6.38). telegramMessage xs:string R true The telegramMessage is system- specific. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 59 oneM2M TS-0023 version 4.8.1 Release 4
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.4 SubDevice models
| |
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.4.1 Common Domain
| |
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.4.1.1 subDeviceCuff
|
A cuff is a subDevice that expresses the attachment device for measuring blood pressure. Table 5.4.1.1-1: Modules of subDeviceCuff model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 0..1 See clause 5.3.1.12. sphygmomanometer sphygmomanometer 1 See clause 5.3.1.83. pulsemeter pulsemeter 1 See clause 5.3.1.68.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.4.1.2 subDevicePowerOutlet
|
A powerOutlet is a subDevice that specifies the attachment device for deviceSmartPlug. Table 5.4.1.2-1: Modules of subDevicePowerOutlet model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 0..1 See clause 5.3.1.12. energyConsumption energyConsumption 0..1 See clause 5.3.1.32. overcurrentSensor overcurrentSensor 0..1 See clause 5.3.1.58. dimmingLevel numberValue 0..1 See clause 5.3.1.55. This provides the capability to change the energy.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.4.2 City Domain
|
For further study.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.4.3 Health Domain
|
For further study.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.4.4 Home Domain
|
For further study.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.4.5 Industry Domain
|
For further study.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.4.6 Vehicular Domain
|
For further study. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 60 oneM2M TS-0023 version 4.8.1 Release 4
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5 Device models
| |
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1 Common Domain
| |
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.1 device3DPrinter
|
A 3D printer is a smart home appliance to provide 3D printing capabilities. Table 5.5.1.1-1: Modules of device3DPrinter Device model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 1 See clause 5.3.1.12. faultDetection faultDetection 0..1 See clause 5.3.1.34. 3Dprinter 3Dprinter 1 See clause 5.3.1.1. runState runState 1 See clause 5.3.1.75. temperature temperature 1 See clause 5.3.1.87. This value of "currentTemperature" in this module instance represents the temperature of the nozzle. This value SHALL be a float number in a range from 0,0 to 1 000,0. printQueue printQueue 1 See clause 5.3.1.67.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.2 deviceAirQualityMonitor
|
An air quality monitor is an environmental monitoring device used to monitor the air quality. Table 5.5.1.2-1: Modules of deviceAirQualityMonitor Device model Module Instance Name Module Class Name Multiplicity Description airQualitySensor airQualitySensor 1 See clause 5.3.1.6. battery battery 0..1 See clause 5.3.1.10. connectivity connectivity 0..1 See clause 5.3.1.25. periodicalReportConfig periodicalReportConfig 0..1 See clause 5.3.1.63.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.3 deviceAudioReceiver
|
An audio receiver is a device that receives audio signals from a number of sources, processing them to drive speakers. Table 5.5.1.3-1: Modules of deviceAudioReceiver model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 1 See clause 5.3.1.12. audioVolume audioVolume 1 See clause 5.3.1.8. mediaInput mediaSelect 0..1 See clause 5.3.1.53. mediaOutput mediaSelect 0..1 See clause 5.3.1.53.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.4 deviceCamera
|
A camera is an optical instrument for recording or capturing images, which may be stored locally or transmitted to another locations. Table 5.5.1.4-1: Modules of deviceCamera Device model Module Instance Name Module Class Name Multiplicity Description sessionDescription sessionDescription 1 See clause 5.3.1.77. playerControl playerControl 0..1 See clause 5.3.1.65. motionSensor motionSensor 0..1 See clause 5.3.1.54. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 61 oneM2M TS-0023 version 4.8.1 Release 4
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.5 deviceDoor
|
A door is a device that is used to open and close a door. Table 5.5.1.5-1: Modules of deviceDoor model Module Instance Name Module Class Name Multiplicity Description openLevel openLevel 0..1 See clause 5.3.1.56. doorlock lock 0..1 See clause 5.3.1.52. doorStatus doorStatus 0..1 See clause 5.3.1.29.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.6 deviceDoorLock
|
A door lock is a device that can be used to lock, for example, a door. Table 5.5.1.6-1: Modules of deviceDoorLock Device model Module Instance Name Module Class Name Multiplicity Description doorLock lock 1 See clause 5.3.1.52. doorStatus doorStatus 0..1 See clause 5.3.1.29. battery battery 0..1 See clause 5.3.1.10.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.7 deviceLight
|
A light is a device that is used to control the state of an illumination appliance. Table 5.5.1.7-1: Modules of deviceLight Device model Module Instance Name Module Class Name Multiplicity Description faultDetection faultDetection 0..1 See clause 5.3.1.34. binarySwitch binarySwitch 1 See clause 5.3.1.12. runState runState 0..1 See clause 5.3.1.75. colour colour 0..1 See clause 5.3.1.23. colourSaturation colourSaturation 0..1 See clause 5.3.1.24. brightness brightness 0..1 See clause 5.3.1.17. timer timer 0..1 See clause 5.3.1.90.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.8 deviceMultiFunctionPrinter
|
A Multi Function Printer (MFP) is an office machine which incorporates the functionality of multiple devices in one, so as to have a smaller footprint in home or office. A typical MFP may act as a combination of printer, scanner and more. This MFP information model provides capabilities to control and monitor MFP specific functions and resources. Table 5.5.1.8-1: Modules of deviceMultiFunctionPrinter Device model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 1 See clause 5.3.1.12. printerRunState runState 1 See clause 5.3.1.75. scannerRunState runState 0..1 See clause 5.3.1.75. autoDocumentFeeder autoDocumentFeeder 0..1 See clause 5.3.1.9. printQueue printQueue 0..1 See clause 5.3.1.67.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.9 devicePrinter
|
A printer is a device that is used to monitor or control the state of a printing appliance. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 62 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.5.1.9-1: Modules of devicePrinter Device model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 1 See clause 5.3.1.12. runState runState 0..1 See clause 5.3.1.75. printQueue printQueue 0..1 See clause 5.3.1.67.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.10 deviceScanner
|
A scanner is a device that optically scans images, printed text, handwriting or an object, and converts it to a digital image. Table 5.5.1.10-1: Modules of deviceScanner model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 1 See clause 5.3.1.12. runState runState 1 See clause 5.3.1.75. autoDocumentFeeder autoDocumentFeeder 0..1 See clause 5.3.1.9.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.11 deviceSmartPlug
|
A smart plug is a device that can turn on and off a connected appliance. Table 5.5.1.11-1: Modules of deviceSmartPlug model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 0..1 See clause 5.3.1.12. faultDetection faultDetection 0..1 See clause 5.3.1.34. remoteControlEnable remoteControlEnable 0..1 See clause 5.3.1.73. Table 5.5.1.11-2: Subdevice of deviceSmartPlug Device model Subdevice Instance Name Subdevice Name Multiplicity Description powerOutlet0 subDevicePowerOutlet 1..N See clause 5.4.1.2.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.12 deviceSwitch
|
A switch is a device that is used to control and monitor the state of power. Table 5.5.1.12-1deviceSwitch Device model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 1 See clause 5.3.1.12.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.13 deviceThermometer
|
A thermometer is a device that can be used to check, for example, the body or other temperatures. Table 5.5.1.13-1: Modules of deviceThermoMeter Device model Module Instance Name Module Class Name Multiplicity Description temperature temperature 1 See clause 5.3.1.87. battery battery 1 See clause 5.3.1.10. temperatureAlarm temperatureAlarm 0..1 See clause 5.3.1.88. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 63 oneM2M TS-0023 version 4.8.1 Release 4
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.14 deviceThermostat
|
A thermostat is used to control the ambient temperature of rooms within, for example, a house. This information model provides capabilities to interact with specific functions of thermostats. Table 5.5.1.14-1: Modules of deviceThermostat Device model Module Instance Name Module Class Name Multiplicity Description runState runState 0..1 See clause 5.3.1.75. The possible values of the "supportedModes" datapoint for the thermostat device are included in clause 5.6.23. timer timer 0..1 See clause 5.3.1.90. temperature temperature 1 See clause 5.3.1.87.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.15 deviceWaterValve
|
A water valve is a device that is used to turn the water supply ON or OFF remotely. Table 5.5.1.15-1: Modules of waterValve Device model Module Instance Name Module Class Name Multiplicity Description openLevel openLevel 1 See clause 5.3.1.56.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.16 deviceServiceButton
|
A service button is a device that initiates and controls technical or business processes, such as ordering consumer and industrial goods over the Internet. It may support optional ModuleClasses to present information to a user, such as presenting textual and graphical information. Table 5.5.1.16-1: Modules of deviceServiceButton Device model Module Instance Name Module Class Name Multiplicity Description pushButton pushButton 1 See clause 5.3.1.69. connectivity connectivity 0..1 See clause 5.3.1.25. operationMode operationMode 0..1 See clause 5.3.1.57. battery battery 0..1 See clause 5.3.1.10. textMessage textMessage 0..1 See clause 5.3.1.89. This ModuleClass may be used to present textual information to a user. image binaryObject 0..1 See clause 5.3.1.11. This ModuleClass may be used to present graphical information to a user. credentials credentials 0..1 See clause 5.3.1.27. geoLocation geoLocation 0..1 See clause 5.3.1.41. This ModuleClass may be used to detect and report the geo-location of a deviceServiceButton device.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.17 deviceGenericSensor
|
A device that is composed of one or more basic sensors. This generic model is proposed to represent very simple appliances that feature one or more sensing behaviours (mono/multi sensors). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 64 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.5.1.17-1: Modules of deviceGenericSensor Device model Module Instance Name Module Class Name Optional Description temperatureAlarm temperatureAlarm 0..1 See clause 5.3.1.88. acousticSensor acousticSensor 0..1 See clause 5.3.1.2. impactSensor impactSensor 0..1 See clause 5.3.1.47. motionSensor motionSensor 0..1 See clause 5.3.1.54. smokeSensor smokeSensor 0..1 See clause 5.3.1.82. uvSensor uvSensor 0..1 See clause 5.3.1.92. waterSensor waterSensor 0..1 See clause 5.3.1.84.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.18 device3DDisplay
|
A 3D display is a device to display 3D contents such as 3D character or holographic image. Table 5.5.1.18-1: Modules of device3DDisplay Device model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 1 See clause 5.3.1.12. clock Clock 0..1 See clause 5.3.1.12. audioVolume audioVolume 0..1 See clause 5.3.1.12. 3DDisplay 3DDisplay 1 See clause 5.3.1.18. connectivity connectivity 1 See clause 5.3.1.54. machineState runState 1 See clause 5.3.1.54. lock lock 0..1 See clause 5.3.1.54.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.1.19 device3DScanner
|
A 3D scanner is a device to scan 3D objects such as a statue of a character. Table 5.5.1.19-1: Modules of device3DScanner device model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 1 See clause 5.3.1.12. clock clock 0..1 See clause 5.3.1.12. 3DScanState runState 1 See clause 5.3.1.75. 3DScanner 3DScanner 1 See clause 5.3.1.117. connectivity connectivity 1 See clause 5.3.1.54.
|
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.2 City Domain
| |
e6ebfc519c3e089619ef5d1ffe3caa64
|
118 123
|
5.5.2.1 deviceOutdoorLamp
|
An outdoor lamp is a smart home appliance to provide lights and information for outside of home with smart sensing capabilities such as ultraviolet sensing. Table 5.5.2.1-1: Modules of deviceOutdoorLamp Device model Module Instance Name Module Class Name Multiplicity Description binarySwitch binarySwitch 1 See clause 5.3.1.12. brightness brightness 0..1 See clause 5.3.1.17. motionSensor motionSensor 0..1 See clause 5.3.1.54. airQualitySensor airQualitySensor 0..1 See clause 5.3.1.6. uvSensor uvSensor 0..1 See clause 5.3.1.92. timer timer 0..1 See clause 5.3.1.90. The timer is used to set duration of giving lights from the moment of triggering by the "brightness" module or "motionSensor" module. faultDetection faultDetection 0..1 See clause 5.3.1.34. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 65 oneM2M TS-0023 version 4.8.1 Release 4
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.