sdfobject-voltage.sdf.json

{
  "info": {
    "title": "OMA/IPSO Voltage (Object ID 3316)",
    "version": "2022-02-22",
    "copyright": "Copyright 2019 Open Mobile Alliance.",
    "license": "BSD-3-Clause"
  },
  "namespace": {
    "oma": "https://onedm.org/ecosystem/oma"
  },
  "defaultNamespace": "oma",
  "sdfObject": {
    "Voltage": {
      "label": "Voltage",
      "description": "This IPSO object should be used with voltmeter sensor to report measured voltage between two points.  It also provides resources for minimum and maximum measured values, as well as the minimum and maximum range that can be measured by the sensor. An example measurement unit is volts.",
      "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"
        },
        "Current_Calibration": {
          "label": "Current Calibration",
          "description": "Read or Write the current calibration coefficient.",
          "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"
        },
        "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/Voltage/sdfProperty/Sensor_Value"
      ]
    }
  }
}