oma-models/sdfObject/sdfobject-generic_sensor.sdf.json at main · one-data-model/oma-models · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
  "info": {
    "title": "OMA/IPSO Generic Sensor (Object ID 3300)",
    "version": "2022-02-22",
    "copyright": "Copyright 2019 Open Mobile Alliance.",
    "license": "BSD-3-Clause"
  },
  "namespace": {
    "oma": "https://onedm.org/ecosystem/oma"
  },
  "defaultNamespace": "oma",
  "sdfObject": {
    "Generic_Sensor": {
      "label": "Generic Sensor",
      "description": "This IPSO object allows the description of a generic sensor. It is based on the description of a value and a unit according to the SenML specification. Thus, any type of value defined within this specification can be reported using this object. This object may be used as a generic object if a dedicated one does not exist.",
      "sdfProperty": {
        "Sensor_Value": {
          "label": "Sensor Value",
          "description": "Last or Current Measured Value from the Sensor.",
          "writable": false,
          "type": "number"
        },
        "Sensor_Units": {
          "label": "Sensor Units",
          "description": "Measurement Units Definition.",
          "writable": false,
          "type": "string"
        },
        "Min_Measured_Value": {
          "label": "Min Measured Value",
          "description": "The minimum value measured by the sensor since power ON or reset.",
          "writable": false,
          "type": "number"
        },
        "Max_Measured_Value": {
          "label": "Max Measured Value",
          "description": "The maximum value measured by the sensor since power ON or reset.",
          "writable": false,
          "type": "number"
        },
        "Min_Range_Value": {
          "label": "Min Range Value",
          "description": "The minimum value that can be measured by the sensor.",
          "writable": false,
          "type": "number"
        },
        "Max_Range_Value": {
          "label": "Max Range Value",
          "description": "The maximum value that can be measured by the sensor.",
          "writable": false,
          "type": "number"
        },
        "Application_Type": {
          "label": "Application Type",
          "description": "The application type of the sensor or actuator as a string depending on the use case.",
          "type": "string"
        },
        "Sensor_Type": {
          "label": "Sensor Type",
          "description": "The type of the sensor (for instance PIR type).",
          "writable": false,
          "type": "string"
        },
        "Timestamp": {
          "label": "Timestamp",
          "description": "The timestamp of when the measurement was performed.",
          "writable": false,
          "type": "number",
          "sdfType": "unix-time"
        },
        "Fractional_Timestamp": {
          "label": "Fractional Timestamp",
          "description": "Fractional part of the timestamp when sub-second precision is used (e.g., 0.23 for 230 ms).",
          "writable": false,
          "type": "number",
          "unit": "s",
          "minimum": 0,
          "maximum": 1
        },
        "Measurement_Quality_Indicator": {
          "label": "Measurement Quality Indicator",
          "description": "Measurement quality indicator reported by a smart sensor. 0: UNCHECKED No quality checks were done because they do not exist or can not be applied. 1: REJECTED WITH CERTAINTY The measured value is invalid. 2: REJECTED WITH PROBABILITY The measured value is likely invalid. 3: ACCEPTED BUT SUSPICIOUS The measured value is likely OK. 4: ACCEPTED The measured value is OK. 5-15: Reserved for future extensions. 16-23: Vendor specific measurement quality.",
          "writable": false,
          "type": "integer",
          "minimum": 0,
          "maximum": 23
        },
        "Measurement_Quality_Level": {
          "label": "Measurement Quality Level",
          "description": "Measurement quality level reported by a smart sensor. Quality level 100 means that the measurement has fully passed quality check algorithms. Smaller quality levels mean that quality has decreased and the measurement has only partially passed quality check algorithms. The smaller the quality level, the more caution should be used by the application when using the measurement. When the quality level is 0 it means that the measurement should certainly be rejected.",
          "writable": false,
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        }
      },
      "sdfAction": {
        "Reset_Min_and_Max_Measured_Values": {
          "label": "Reset Min and Max Measured Values",
          "description": "Reset the Min and Max Measured Values to Current Value."
        }
      },
      "sdfRequired": [
        "#/sdfObject/Generic_Sensor/sdfProperty/Sensor_Value"
      ]
    }
  }
}