7.1 OMA GotAPI(DWAPI)
7.1.1 Introduction
The following clauses are intended to specify the mapping relationship between HAIM and OMA DWAPI with tables.
OMA Device Web Application Programming Interface (DWAPI)) [7] is based on OMA Generic Open Terminal Application Programming Interface (GotAPI) [19] and supports Personal Healthcare Devices (DWAPI-PCH) and 3D printer (DWAPI-3DP).
OMA DWAPI has no concept that corresponds to ModuleClass in oneM2M. The mappings of DataPoints to data objects of OMA DWAPI are expressed in following clauses.
7.1.2 Device Models
7.1.2.1 device3Dprinter
The device3DPrinter of HAIM shall be mapped to 3D printer of OMA DWAPI-3DP on the basis of Table 7.1.2.1-1.
Table 7.1.2.1-1: Map of device3Dprinter of oneM2M HAIM to OMA DWAPI-3DP
| ModuleClass | Data Points of oneM2M HAIM | data objects of OMA DWAPI-3DP | Description |
|---|---|---|---|
| binarySwitch | powerState | - | See clause 5.3.1.12. The powerState is not supported in OMA DWAPI-3DP data object. The power state is assumed power-on in OMA DWAPI-3DP. |
| faultDetection | code | operatingStatus | See clause 5.3.1.34. It shall be the integer type at HAIM, but shall be the string type at OMA DWAPI-3DP. See the Table 7.1.2-2 . |
| threeDprinter | printType | printType | See clause 5.3.1.1. |
| threeDprinter | printSizeX | printSizeX | See clause 5.3.1.1. |
| threeDprinter | printSizeY | printSizeY | See clause 5.3.1.1. |
| threeDprinter | printSizeZ | printSizeZ | See clause 5.3.1.1. |
| threeDprinter | network | network | See clause 5.3.1.1. |
| threeDprinter | memorySize | memorySize | See clause 5.3.1.1. |
| runState | currentMachineState | operatingStatus | See clause 5.3.1.75. This value represents the machineState of the 3D printer itself. This value SHALL be interpreted by using hd:enumMachineState and generated operatingStatus as a string. See the Table 7.1.2-2 . |
| temperature | currentTemperature | nozzleTemp | See clause 5.3.1.87. This value represents the temperature of the nozzle. This value SHALL be a float number in a range from 0,0 to 1 000,0. The unit is C. |
| printQueue | uri | uri | See clause 5.3.1.67. |
| printQueue | printingState | msg | See clause 5.3.1.67. This value represents the machineState of the queued printing job. This value shall be interpreted by using hd:enumMachineState and generated msg as a string. See the Table 7.1.2-3. |
Table 7.1.2.1-2: Map of hd:enumMachineState of oneM2M HAIM to operatingStatus of OMA DWAPI-3DP
| Value | Interpretation | operatingStatus of OMA DWAPI-3DP | Note |
|---|---|---|---|
| 1 | idle | RDY | Ready to use |
| 2 | preActive | Not available | |
| 3 | active | RUN | Under printing operation |
| 4 | reserved | Not available | |
| 5 | stopped | Not available | |
| 6 | error | MAN | Maintenance needed |
| 7 | diagnostic | Not available | |
| 8 | test | Not available | |
| 9 | maintenance | MAN | Maintenance needed |
| 10 | clear | CLR | Printing completed but the result is not removed yet |
| 11 | charging | Not available |
Table 7.1.2-1-3: Map of hd:enumJobState of oneM2M HAIM to msg of OMA DWAPI-3DP
| Value | Interpretation | msg of OMA DWAPI-3DP | Note |
|---|---|---|---|
| 1 | aborted | Not available | |
| 2 | cancelled | Not available | |
| 3 | completed | Completed | |
| 4 | paused | Waiting | |
| 5 | pending | Waiting | |
| 6 | processing | Good Start |
7.1.2.2 deviceBloodPressureMonitor
DeviceBloodPressureMonitor of HAIM shall be mapped to Blood Pressure Monitor of OMA DWAPI-PCH on the basis of Table 7.1.2.2-1.
Table 7.1.2-2-1: Map of deviceBloodPressureMonitor of oneM2M HAIM to OMA DWAPI-PCH
| ModuleClass | DataPoints of oneM2M HAIM | data objects of OMA DWAPI-PCH | Description |
|---|---|---|---|
| sphygmomanometer | diastolicPressure | diastolic | See clause 5.3.1.83. |
| sphygmomanometer | systolicPressure | systolic | See clause 5.3.1.83. |
| sphygmomanometer | meanPressure | mean | See clause 5.3.1.83. |
| pulsemeter | pulseRate | pulse | See clause 5.3.1.68. |
| battery | level | batteryLevel | See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI-PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] atOMA DWAPI-PCH. |
7.1.2.3 deviceGlucosemeter
DeviceGlucometer of HAIM shall be mapped to Glucometer of OMA DWAPI-PCH on the basis of Table 7.1.2.3-1.
Table 7.1.2.3-1: Map of deviceGlucometer of oneM2M HAIM to OMA DWAPI-PCH
| ModuleClass | DataPoints of oneM2M HAIM | data objects of OMA DWAPI-PCH | Description |
|---|---|---|---|
| glucometer | concentration | concentration | See clause 5.3.1.42. |
| glucometer | hba1c | hba1c | See clause 5.3.1.42. |
| glucometer | contextExercise | contextExercise | See clause 5.3.1.42. |
| glucometer | contextMedication | contextMedication | See clause 5.3.1.42. |
| glucometer | contextCarbohydratesAmount | contextCarbohydrates | See clause 5.3.1.42. |
| glucometer | contextCarbohydratesSource | contextCarbohydrates | See clause 5.3.1.42. |
| glucometer | contextMeal | contextMeal | See clause 5.3.1.42. |
| glucometer | contextLocation | contextLocation | See clause 5.3.1.42. |
| glucometer | contextTester | contextTester | See clause 5.3.1.42. |
| glucometer | contextHealth | contextHealth | See clause 5.3.1.42. |
| battery | level | batteryLevel | See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI-PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] atOMA DWAPI-PCH. |
7.1.2.4 devicePulseOximeter
DevicePulseOximeter of HAIM shall be mapped to Pulse Oximeter of OMA DWAPI-PCH on the basis of Table 7.1.2.4-1.
Table 7.1.2.4-1: Map of devicePulseOximeter of oneM2M HAIM to OMA DWAPI-PCH
| ModuleClass | DataPoints of oneM2M HAIM | data objects of OMA DWAPI-PCH | Description |
|---|---|---|---|
| pulsemeter | modality | spo2, pulse | See clause 5.3.1.68. When "oximeter" module does not exist, "pulsemeter" module is mandatory. |
| oximeter | modality | spo2, pulse | See clause 5.3.1.59. When "pulsemeter" module does not exist, ""oximeter" module is mandatory. |
| battery | level | batteryLevel | See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI-PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] atOMA DWAPI-PCH. |
7.1.2.5 deviceThermometer
DeviceTermometer of HAIM shall be mapped to Thermometer of OMA DWAPI-PCH on the basis of Table 7.1.2.5-1.
Table 7.1.2.5-1: Map of deviceThermometer of oneM2M HAIM to OMA DWAPI-PCH
| ModuleClass | Data Points of oneM2M HAIM | data objects of OMA DWAPI-PCH | Description |
|---|---|---|---|
| temperature | unit | temperature | See clause 5.3.1.87. |
| battery | level | batteryLevel | See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI-PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] atOMA DWAPI-PCH. |
7.1.2.6 deviceWeightScaleAndBodyCompositionAnalyser
DeviceWeightScaleAdBodyCompositionAnalyser of HAIM shall be mapped to Weight Scale Body Composition Analyser of OMA DWAPI-PCH on the basis of Table .
Table 7.1.2.6-1: Map of deviceWeightScaleAdBodyCompositionAnalyser of oneM2M HAIM to OMA DWAPI-PCH
| ModuleClass | DataPoints of oneM2M HAIM | data objects of OMA DWAPI-PCH | Description |
|---|---|---|---|
| bodyCompositionAnalyser | bodyLength | bodyLength | See clause 5.3.1.14. |
| bodyCompositionAnalyser | Bmi | bmi | See clause 5.3.1.14. |
| bodyCompositionAnalyser | fatFreeMass | fatFreeMass | See clause 5.3.1.14. |
| bodyCompositionAnalyser | softLeanMass | softLeanMass | See clause 5.3.1.14. |
| bodyCompositionAnalyser | muscleMass | muscleMass | See clause 5.3.1.14. |
| bodyCompositionAnalyser | basalMetabolism | basalMetabolism | See clause 5.3.1.14. |
| bodyCompositionAnalyser | impedance | impedance | See clause 5.3.1.14. |
| weight | weight | bodyMass | See clause 5.3.1.99. |
| bioElectricalImpedanceAnalysis | water | bodyWater | See clause 5.3.1.13. |
| bioElectricalImpedanceAnalysis | fat | bodyFat | See clause 5.3.1.13. |
| bioElectricalImpedanceAnalysis | muscle | musclePercentage | See clause 5.3.1.13. |
| battery | level | batteryLevel | See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI-PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] at OMA DWAPI-PCH. |
7.1.2.7 deviceHeartRateMonitor
DeviceHeartRateMonitor of HAIM shall be mapped to Heart Rate Monitor of OMA DWAPI-PCH on the basis of Table 7.1.2.7-1.
Table 7.1.2.7-1: Map of deviceHeartRateMonitor of oneM2M HAIM to OMA DWAPI-PCH
| ModuleClass | DataPoints of oneM2M HAIM | data objects of OMA DWAPI-PCH | Description |
|---|---|---|---|
| pulsemeter | pulseRate | rate | See clause 5.3.1.68. |
| pulsemeter | rr | rr | See clause 5.3.1.68. |
| pulsemeter | energy | energy | See clause 5.3.1.68. |
| battery | level | batteryLevel | See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI-PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] atOMA DWAPI-PCH. |
7.1.3 Data Types
Data types of oneM2M HAIM and OMA DWAPI-PCH shall be mapped each other on the basis of Table 7.1.3-1.
Table 7.1.3-1: Map of data types between oneM2M and OMA DWAPI-PCH
| oneM2M data type | Mapping to data type in OMA DWAPI | Description |
|---|---|---|
| xs:integer | int, number, string | Data type for 32-bit signed integer. For indicating 3D printerState, the integer value should be interpreted into string by referring the tables in clause 7.1.2.1 . |
| xs:string | string, array | Data type for text. The length limitation should be considered for the mapping. |
| xs:float | float | Data type for a single precision 32-bit floating point type as defined in XML Schema 1.0 [14] as the float primitive type. |
| xs:boolean | boolean | Data type for Boolean. |