-
Notifications
You must be signed in to change notification settings - Fork 0
/
sdfobject-colour.swagger.json
139 lines (139 loc) · 4.54 KB
/
sdfobject-colour.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
137
138
139
{
"swagger": "2.0",
"info": {
"title": "OMA/IPSO Colour (Object ID 3335)",
"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": {
"/Omaipsocolourobjectid3335ResURI": {
"get": {
"description": " This IPSO object should be used to report the measured value of a colour sensor in some colour space described by the units resource.",
"parameters": [
{
"$ref": "#/parameters/interface"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/Omaipsocolourobjectid3335"
}
}
}
}
}
},
"parameters": {
"interface": {
"in": "query",
"name": "if",
"type": "string",
"enum": [
"oic.if.s",
"oic.if.baseline"
]
}
},
"definitions": {
"Omaipsocolourobjectid3335": {
"properties": {
"rt": {
"description": "The Resource Type.",
"items": {
"enum": [
"oic.r.o.colour"
],
"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"
},
"Colour": {
"description": "A string representing a value in some color space.",
"x-label": "Colour",
"type": "string"
},
"Sensor_Units": {
"description": "Measurement Units Definition.",
"x-label": "Sensor Units",
"type": "string",
"readOnly": true
},
"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": [
"Colour"
]
}
}
}