OMA-IoTDataModels/sdfobject-dimmer.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
{
  "swagger": "2.0",
  "info": {
    "title": "OMA/IPSO Dimmer (Object ID 3343)",
    "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": {
    "/Omaipsodimmerobjectid3343ResURI": {
      "get": {
        "description": " This IPSO object should be used with a dimmer or level control to report the state of the control.",
        "parameters": [
          {
            "$ref": "#/parameters/interface"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/Omaipsodimmerobjectid3343"
            }
          }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": [
        "oic.if.s",
        "oic.if.baseline"
      ]
    }
  },
  "definitions": {
    "Omaipsodimmerobjectid3343": {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": [
              "oic.r.o.dimmer"
            ],
            "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"
        },
        "Level": {
          "description": "Used to represent a level control such as audio volume.",
          "x-label": "Level",
          "maximum": 100,
          "minimum": 0,
          "type": "number",
          "x-unit": "/100"
        },
        "On_time": {
          "description": "The time in seconds that the device has been on. Writing a value of 0 resets the counter.",
          "x-label": "On time",
          "type": "integer",
          "x-unit": "s"
        },
        "Off_Time": {
          "description": "The time in seconds in the off state. Writing a value of 0 resets the counter.",
          "x-label": "Off Time",
          "type": "integer",
          "x-unit": "s"
        },
        "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"
        }
      },
      "type": "object",
      "required": [
        "Level"
      ]
    }
  }
}