sdfobject-presence.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "OMA/IPSO Presence (Object ID 3302)",
    "version": "2022-02-22",
    "license": {
      "name": "BSD-3-Clause",
      "x-copyright": "Copyright 2019 Open Mobile Alliance."
    }
  },
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/Omaipsopresenceobjectid3302ResURI": {
      "get": {
        "description": " Presence sensor with digital sensing, optional delay parameters",
        "parameters": [
          {
            "$ref": "#/parameters/interface"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/Omaipsopresenceobjectid3302"
            }
          }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": [
        "oic.if.s",
        "oic.if.baseline"
      ]
    }
  },
  "definitions": {
    "Omaipsopresenceobjectid3302": {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": [
              "oic.r.o.presence"
            ],
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "n": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.s",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "Digital_Input_State": {
          "description": "The current state of a digital input.",
          "x-label": "Digital Input State",
          "type": "boolean",
          "readOnly": true
        },
        "Digital_Input_Counter": {
          "description": "The cumulative value of active state detected.",
          "x-label": "Digital Input Counter",
          "type": "integer",
          "readOnly": true
        },
        "Sensor_Type": {
          "description": "The type of the sensor (for instance PIR type).",
          "x-label": "Sensor Type",
          "type": "string",
          "readOnly": true
        },
        "Busy_to_Clear_delay": {
          "description": "Delay from the detection state to the clear state in ms.",
          "x-label": "Busy to Clear delay",
          "type": "integer",
          "x-unit": "ms"
        },
        "Clear_to_Busy_delay": {
          "description": "Delay from the clear state to the busy state in ms.",
          "x-label": "Clear to Busy delay",
          "type": "integer",
          "x-unit": "ms"
        },
        "Application_Type": {
          "description": "The application type of the sensor or actuator as a string depending on the use case.",
          "x-label": "Application Type",
          "type": "string"
        },
        "Timestamp": {
          "description": "The timestamp of when the measurement was performed.",
          "x-label": "Timestamp",
          "x-sdfType": "unix-time",
          "type": "number",
          "readOnly": true
        },
        "Fractional_Timestamp": {
          "description": "Fractional part of the timestamp when sub-second precision is used (e.g., 0.23 for 230 ms).",
          "x-label": "Fractional Timestamp",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-unit": "s",
          "readOnly": true
        },
        "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.",
          "x-label": "Measurement Quality Indicator",
          "maximum": 23,
          "minimum": 0,
          "type": "integer",
          "readOnly": true
        },
        "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.",
          "x-label": "Measurement Quality Level",
          "maximum": 100,
          "minimum": 0,
          "type": "integer",
          "readOnly": true
        }
      },
      "type": "object",
      "required": [
        "Digital_Input_State"
      ]
    }
  }
}