sdfobject-digital_input.sdf.json

{
  "info": {
    "title": "OMA/IPSO Digital Input (Object ID 3200)",
    "version": "2022-02-22",
    "copyright": "Copyright 2019 Open Mobile Alliance.",
    "license": "BSD-3-Clause"
  },
  "namespace": {
    "oma": "https://onedm.org/ecosystem/oma"
  },
  "defaultNamespace": "oma",
  "sdfObject": {
    "Digital_Input": {
      "label": "Digital Input",
      "description": "Generic digital input for non-specific sensors",
      "sdfProperty": {
        "Digital_Input_State": {
          "label": "Digital Input State",
          "description": "The current state of a digital input.",
          "writable": false,
          "type": "boolean"
        },
        "Digital_Input_Counter": {
          "label": "Digital Input Counter",
          "description": "The cumulative value of active state detected.",
          "writable": false,
          "type": "integer"
        },
        "Digital_Input_Polarity": {
          "label": "Digital Input Polarity",
          "description": "The polarity of the digital input as a Boolean (False = Normal, True = Reversed).",
          "type": "boolean"
        },
        "Digital_Input_Debounce": {
          "label": "Digital Input Debounce",
          "description": "The debounce period in ms.",
          "type": "integer",
          "unit": "ms"
        },
        "Digital_Input_Edge_Selection": {
          "label": "Digital Input Edge Selection",
          "description": "The edge selection as an integer (1 = Falling edge, 2 = Rising edge, 3 = Both Rising and Falling edge).",
          "type": "integer",
          "minimum": 1,
          "maximum": 3
        },
        "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
        }
      },
      "sdfAction": {
        "Digital_Input_Counter_Reset": {
          "label": "Digital Input Counter Reset",
          "description": "Reset the Counter value."
        }
      },
      "sdfRequired": [
        "#/sdfObject/Digital_Input/sdfProperty/Digital_Input_State"
      ]
    }
  }
}