-
Notifications
You must be signed in to change notification settings - Fork 69
/
environment.json
401 lines (401 loc) · 14.2 KB
/
environment.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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://signalk.org/specification/1.5.1/schemas/groups/environment.json#",
"description": "Schema describing the environmental child-object of a Vessel.",
"title": "environment",
"definitions": {
"zoneObject": {
"type": "object",
"properties": {
"temperature": {
"description": "Temperature",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"heatIndexTemperature": {
"description": "Current heat index temperature in zone",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"pressure": {
"description": "Pressure in zone",
"units": "Pa",
"$ref": "../definitions.json#/definitions/numberValue"
},
"relativeHumidity": {
"description": "Relative humidity in zone",
"units": "ratio",
"$ref": "../definitions.json#/definitions/numberValue"
},
"dewPoint": {
"description": "DEPRECATED: use dewPointTemperature",
"units": "K",
"$ref": "../definitions.json#/definitions/numberValue"
},
"dewPointTemperature": {
"description": "Dewpoint in zone",
"units": "K",
"$ref": "../definitions.json#/definitions/numberValue"
},
"airDensity": {
"description": "Air density in zone",
"units": "kg/m3",
"$ref": "../definitions.json#/definitions/numberValue"
},
"illuminance": {
"description": "Illuminance in zone",
"units": "Lux",
"$ref": "../definitions.json#/definitions/numberValue"
}
}
}
},
"properties": {
"outside": {
"description": "Environmental conditions outside of the vessel's hull",
"type": "object",
"properties": {
"temperature": {
"description": "Current outside air temperature",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"dewPointTemperature": {
"description": "Current outside dew point temperature",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"apparentWindChillTemperature": {
"description": "Current outside apparent wind chill temperature",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"theoreticalWindChillTemperature": {
"description": "Current outside theoretical wind chill temperature",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"heatIndexTemperature": {
"description": "Current outside heat index temperature",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"pressure": {
"description": "Current outside air ambient pressure",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "Pa"
},
"humidity": {
"description": "DEPRECATED: use relativeHumidity",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "ratio"
},
"relativeHumidity": {
"description": "Current outside air relative humidity",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "ratio"
},
"airDensity": {
"description": "Current outside air density",
"units": "kg/m3",
"$ref": "../definitions.json#/definitions/numberValue"
},
"illuminance": {
"description": "Current outside ambient light flux.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "Lux"
}
}
},
"inside": {
"type": "object",
"description": "Environmental conditions inside the vessel's hull",
"allOf": [
{
"patternProperties": {
"[A-Za-z0-9]+": {
"description": "This regex pattern is used for validation of the identifier for the environmental zone, eg. engineRoom, mainCabin, refrigerator",
"$ref": "#/definitions/zoneObject"
}
}
},
{
"$ref": "#/definitions/zoneObject"
}
]
},
"water": {
"type": "object",
"description": "Environmental conditions of the water that the vessel is sailing in",
"properties": {
"temperature": {
"description": "Current water temperature",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"salinity": {
"description": "Water salinity",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "ratio"
}
}
},
"depth": {
"title": "depth",
"type": "object",
"description": "Depth related data",
"properties": {
"belowKeel": {
"description": "Depth below keel",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"belowTransducer": {
"description": "Depth below Transducer",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"belowSurface": {
"description": "Depth from surface",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"transducerToKeel": {
"description": "Depth from the transducer to the bottom of the keel",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"surfaceToTransducer": {
"description": "Depth transducer is below the water surface",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
}
}
},
"current": {
"type": "object",
"title": "current",
"description": "Direction and strength of current affecting the vessel",
"allOf": [
{
"$ref": "../definitions.json#/definitions/commonValueFields"
},
{
"properties": {
"value": {
"type": "object",
"properties": {
"drift": {
"type": "number",
"description": "The speed component of the water current vector",
"example": 3.12,
"units": "m/s"
},
"setTrue": {
"type": "number",
"description": "The direction component of the water current vector referenced to true (geographic) north",
"example": 123.45,
"units": "rad"
},
"setMagnetic": {
"type": "number",
"description": "The direction component of the water current vector referenced to magnetic north",
"example": 131.22,
"units": "rad"
}
}
},
"values": {
"type": "object",
"patternProperties": {
".*": {
"type": "object",
"properties": {
"timestamp": {
"$ref": "../definitions.json#/definitions/timestamp"
},
"pgn": {
"type": "number"
},
"sentence": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"drift": {
"type": "number",
"description": "The speed component of the water current vector",
"example": 3.12,
"units": "m/s"
},
"setTrue": {
"type": "number",
"description": "The direction component of the water current vector referenced to true (geographic) north",
"example": 123.45,
"units": "rad"
},
"setMagnetic": {
"type": "number",
"description": "The direction component of the water current vector referenced to magnetic north",
"example": 131.22,
"units": "rad"
}
}
}
}
}
}
}
}
}
]
},
"tide": {
"type": "object",
"title": "tide",
"description": "Tide data",
"properties": {
"heightHigh": {
"description": "Next high tide height relative to lowest astronomical tide (LAT/Chart Datum)",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"heightNow": {
"description": "The current tide height relative to lowest astronomical tide (LAT/Chart Datum)",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"heightLow": {
"description": "The next low tide height relative to lowest astronomical tide (LAT/Chart Datum)",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"timeLow": {
"description": "Time of the next low tide in UTC",
"$ref": "../definitions.json#/definitions/timestamp"
},
"timeHigh": {
"description": "Time of next high tide in UTC",
"$ref": "../definitions.json#/definitions/timestamp"
}
}
},
"heave": {
"description": "Vertical movement of the vessel due to waves",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"wind": {
"type": "object",
"title": "wind",
"description": "Wind data.",
"properties": {
"angleApparent": {
"description": "Apparent wind angle, negative to port",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
},
"angleTrueGround": {
"description": "True wind angle based on speed over ground, negative to port",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
},
"angleTrueWater": {
"description": "True wind angle based on speed through water, negative to port",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
},
"directionChangeAlarm": {
"description": "The angle the wind needs to shift to raise an alarm",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
},
"directionTrue": {
"description": "The wind direction relative to true north",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
},
"directionMagnetic": {
"description": "The wind direction relative to magnetic north",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
},
"speedTrue": {
"description": "Wind speed over water (as calculated from speedApparent and vessel's speed through water)",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m/s"
},
"speedOverGround": {
"description": "Wind speed over ground (as calculated from speedApparent and vessel's speed over ground)",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m/s"
},
"speedApparent": {
"description": "Apparent wind speed",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m/s"
}
}
},
"time": {
"type": "object",
"description": "A time reference for the vessel. All clocks on the vessel dispaying local time should use the timezone offset here. If a timezoneRegion is supplied the timezone must also be supplied. If timezoneRegion is supplied that should be displayed by UIs in preference to simply timezone. ie 12:05 (Europe/London) should be displayed in preference to 12:05 (UTC+01:00)",
"properties": {
"millis": {
"type": "number",
"title": "Epoch time",
"example": 1449648657735,
"description": "Milliseconds since the UNIX epoch (1970-01-01 00:00:00)"
},
"timezoneOffset": {
"type": "number",
"title": "Timezone offset",
"example": -400,
"maximum": 1300,
"minimum": -1300,
"description": "Onboard timezone offset from UTC in hours and minutes (-)hhmm. +ve means east of Greenwich. For use by UIs",
"default": 0
},
"timezoneRegion": {
"type": "string",
"title": "IANA Timezone national region",
"example": "Europe/Zurich",
"description": "Onboard timezone offset as listed in the IANA timezone database (tz database)",
"pattern": "^[a-zA-Z0-9\/+-]+$"
},
"timestamp": {
"$ref": "../definitions.json#/definitions/timestamp"
},
"source": {
"$ref": "../definitions.json#/definitions/source"
}
},
"dependencies": {
"timezoneRegion": [
"timezoneOffset"
]
}
},
"mode": {
"type": "object",
"description": "Mode of the vessel based on the current conditions. Can be combined with navigation.state to control vessel signals eg switch to night mode for instrumentation and lights, or make sound signals for fog.",
"properties": {
"value": {
"enum": [
"day",
"night",
"restricted visibility"
]
},
"timestamp": {
"$ref": "../definitions.json#/definitions/timestamp"
},
"source": {
"$ref": "../definitions.json#/definitions/source"
}
}
}
}
}