-
Notifications
You must be signed in to change notification settings - Fork 0
/
sdfobject-actuation.swagger.json
136 lines (136 loc) · 3.9 KB
/
sdfobject-actuation.swagger.json
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
{
"swagger": "2.0",
"info": {
"title": "OMA/IPSO Actuation (Object ID 3306)",
"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": {
"/Omaipsoactuationobjectid3306ResURI": {
"get": {
"description": " This IPSO object is dedicated to remote actuation such as ON/OFF action or dimming. A multi-state output can also be described as a string. This is useful to send pilot wire orders for instance. It also provides a resource to reflect the time that the device has been switched on.",
"parameters": [
{
"$ref": "#/parameters/interface"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/Omaipsoactuationobjectid3306"
}
}
}
}
}
},
"parameters": {
"interface": {
"in": "query",
"name": "if",
"type": "string",
"enum": [
"oic.if.s",
"oic.if.baseline"
]
}
},
"definitions": {
"Omaipsoactuationobjectid3306": {
"properties": {
"rt": {
"description": "The Resource Type.",
"items": {
"enum": [
"oic.r.o.actuation"
],
"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"
},
"On_Off": {
"description": "On/off control. Boolean value where True is On and False is Off.",
"x-label": "On/Off",
"type": "boolean"
},
"Dimmer": {
"description": "This resource represents a dimmer setting, which has an Integer value between 0 and 100 as a percentage.",
"x-label": "Dimmer",
"maximum": 100,
"minimum": 0,
"type": "integer",
"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"
},
"Multi-state_Output": {
"description": "A string describing a state for multiple level output such as Pilot Wire.",
"x-label": "Multi-state Output",
"type": "string"
},
"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
}
},
"type": "object",
"required": [
"On_Off"
]
}
}
}