OMA-IoTDataModels/sdfobject-digital_input.swagger.json at master · openconnectivityfoundation/OMA-IoTDataModels · 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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
{
  "swagger": "2.0",
  "info": {
    "title": "OMA/IPSO Digital Input (Object ID 3200)",
    "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": {
    "/Omaipsodigitalinputobjectid3200ResURI": {
      "get": {
        "description": " Generic digital input for non-specific sensors",
        "parameters": [
          {
            "$ref": "#/parameters/interface"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/Omaipsodigitalinputobjectid3200"
            }
          }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": [
        "oic.if.s",
        "oic.if.baseline"
      ]
    }
  },
  "definitions": {
    "Omaipsodigitalinputobjectid3200": {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": [
              "oic.r.o.digital.input"
            ],
            "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
        },
        "Digital_Input_Polarity": {
          "description": "The polarity of the digital input as a Boolean (False = Normal, True = Reversed).",
          "x-label": "Digital Input Polarity",
          "type": "boolean"
        },
        "Digital_Input_Debounce": {
          "description": "The debounce period in ms.",
          "x-label": "Digital Input Debounce",
          "type": "integer",
          "x-unit": "ms"
        },
        "Digital_Input_Edge_Selection": {
          "description": "The edge selection as an integer (1 = Falling edge, 2 = Rising edge, 3 = Both Rising and Falling edge).",
          "x-label": "Digital Input Edge Selection",
          "maximum": 3,
          "minimum": 1,
          "type": "integer"
        },
        "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"
        },
        "Sensor_Type": {
          "description": "The type of the sensor (for instance PIR type).",
          "x-label": "Sensor Type",
          "type": "string",
          "readOnly": true
        },
        "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
        }
      },
      "type": "object",
      "required": [
        "Digital_Input_State"
      ]
    }
  }
}