@signalk/freeboard-sk 2.19.0-beta.1 → 2.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/plugin/alarms/alarms.js +486 -3
- package/plugin/index.js +15 -0
- package/plugin/openApi.json +123 -1
- package/public/assets/help/index.html +26 -0
- package/public/index.html +1 -1
- package/public/main.bf1f82cf3703dabc.js +1 -0
- package/plugin/flags/flags-service.js +0 -132
- package/plugin/flags/mid.js +0 -1745
- package/plugin/weather/openweather.js +0 -175
- package/plugin/weather/weather-service.js +0 -413
- package/public/main.30f0db8afdde9114.js +0 -1
package/plugin/openApi.json
CHANGED
|
@@ -22,7 +22,11 @@
|
|
|
22
22
|
"tags": [
|
|
23
23
|
{
|
|
24
24
|
"name": "Alarms",
|
|
25
|
-
"description": "
|
|
25
|
+
"description": "Standard alarms."
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "Areas",
|
|
29
|
+
"description": "Area alarms."
|
|
26
30
|
}
|
|
27
31
|
],
|
|
28
32
|
"components": {
|
|
@@ -46,6 +50,38 @@
|
|
|
46
50
|
"description": "Date / Time when data values were recorded",
|
|
47
51
|
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}(?:\\.\\d*)?)((-(\\d{2}):(\\d{2})|Z)?)$",
|
|
48
52
|
"example": "2022-04-22T05:02:56.484Z"
|
|
53
|
+
},
|
|
54
|
+
"AreaAlarmDef": {
|
|
55
|
+
"type": "object",
|
|
56
|
+
"required": ["trigger", "geometry"],
|
|
57
|
+
"properties": {
|
|
58
|
+
"geometry": {
|
|
59
|
+
"type": "string",
|
|
60
|
+
"enum": ["polygon", "circle", "region"]
|
|
61
|
+
},
|
|
62
|
+
"trigger": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"enum": ["entry", "exit"]
|
|
65
|
+
},
|
|
66
|
+
"coords": {
|
|
67
|
+
"type": "array",
|
|
68
|
+
"items": {
|
|
69
|
+
"$ref": "#/components/schemas/Position"
|
|
70
|
+
},
|
|
71
|
+
"description": "Coordinates of the alarm area. `(required when geometry = 'polygon')`"
|
|
72
|
+
},
|
|
73
|
+
"center": {
|
|
74
|
+
"$ref": "#/components/schemas/Position",
|
|
75
|
+
"description": "Center of circlular area. `(required when geometry = 'circle')`"
|
|
76
|
+
},
|
|
77
|
+
"radius": {
|
|
78
|
+
"type": "number",
|
|
79
|
+
"description": "Circle radius in meters. `(required when geometry = 'circle')`"
|
|
80
|
+
},
|
|
81
|
+
"name": {
|
|
82
|
+
"type": "string"
|
|
83
|
+
}
|
|
84
|
+
}
|
|
49
85
|
}
|
|
50
86
|
},
|
|
51
87
|
"responses": {
|
|
@@ -145,6 +181,92 @@
|
|
|
145
181
|
},
|
|
146
182
|
"security": [{ "cookieAuth": [] }, { "bearerAuth": [] }],
|
|
147
183
|
"paths": {
|
|
184
|
+
"/signalk/v2/api/alarms/area": {
|
|
185
|
+
"post": {
|
|
186
|
+
"tags": ["Areas"],
|
|
187
|
+
"summary": "Set Alarm area.",
|
|
188
|
+
"requestBody": {
|
|
189
|
+
"description": "Sets the defined area to monitor for vessel entry /exit.",
|
|
190
|
+
"required": true,
|
|
191
|
+
"content": {
|
|
192
|
+
"application/json": {
|
|
193
|
+
"schema": {
|
|
194
|
+
"$ref": "#/components/schemas/AreaAlarmDef"
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
},
|
|
199
|
+
"responses": {
|
|
200
|
+
"200ActionResponse": {
|
|
201
|
+
"$ref": "#/components/responses/200OKResponse"
|
|
202
|
+
},
|
|
203
|
+
"default": {
|
|
204
|
+
"$ref": "#/components/responses/ErrorResponse"
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
},
|
|
209
|
+
"/signalk/v2/api/alarms/area/{id}": {
|
|
210
|
+
"parameters": [
|
|
211
|
+
{
|
|
212
|
+
"$ref": "#/components/parameters/AlarmIdParam"
|
|
213
|
+
}
|
|
214
|
+
],
|
|
215
|
+
"put": {
|
|
216
|
+
"tags": ["Areas"],
|
|
217
|
+
"summary": "Update Alarm area OR Set the `Region` resource with the supplied identifier as the alarm area.",
|
|
218
|
+
"requestBody": {
|
|
219
|
+
"description": "Updates the area details for the supplied area identfier.",
|
|
220
|
+
"required": true,
|
|
221
|
+
"content": {
|
|
222
|
+
"application/json": {
|
|
223
|
+
"schema": {
|
|
224
|
+
"$ref": "#/components/schemas/AreaAlarmDef"
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
},
|
|
229
|
+
"responses": {
|
|
230
|
+
"200ActionResponse": {
|
|
231
|
+
"$ref": "#/components/responses/200OKResponse"
|
|
232
|
+
},
|
|
233
|
+
"default": {
|
|
234
|
+
"$ref": "#/components/responses/ErrorResponse"
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
},
|
|
238
|
+
"delete": {
|
|
239
|
+
"tags": ["Areas"],
|
|
240
|
+
"summary": "Clear / cancel Area Alarm.",
|
|
241
|
+
"responses": {
|
|
242
|
+
"200ActionResponse": {
|
|
243
|
+
"$ref": "#/components/responses/200OKResponse"
|
|
244
|
+
},
|
|
245
|
+
"default": {
|
|
246
|
+
"$ref": "#/components/responses/ErrorResponse"
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
},
|
|
251
|
+
"/signalk/v2/api/alarms/area/{id}/silence": {
|
|
252
|
+
"parameters": [
|
|
253
|
+
{
|
|
254
|
+
"$ref": "#/components/parameters/AlarmIdParam"
|
|
255
|
+
}
|
|
256
|
+
],
|
|
257
|
+
"post": {
|
|
258
|
+
"tags": ["Areas"],
|
|
259
|
+
"summary": "Silence Area Alarm.",
|
|
260
|
+
"responses": {
|
|
261
|
+
"200ActionResponse": {
|
|
262
|
+
"$ref": "#/components/responses/200OKResponse"
|
|
263
|
+
},
|
|
264
|
+
"default": {
|
|
265
|
+
"$ref": "#/components/responses/ErrorResponse"
|
|
266
|
+
}
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
},
|
|
148
270
|
"/signalk/v2/api/alarms/{alarmType}": {
|
|
149
271
|
"parameters": [
|
|
150
272
|
{
|
|
@@ -97,6 +97,7 @@
|
|
|
97
97
|
<li>Anchor Watch</li>
|
|
98
98
|
<li>Depth</li>
|
|
99
99
|
<li>Crossing Vessel / Closest Approach</li>
|
|
100
|
+
<li>Hazardous Region entry</li>
|
|
100
101
|
</ul>
|
|
101
102
|
</li>
|
|
102
103
|
<li>
|
|
@@ -1235,6 +1236,31 @@
|
|
|
1235
1236
|
detailed charts are on top.
|
|
1236
1237
|
</div>
|
|
1237
1238
|
</div>
|
|
1239
|
+
<hr />
|
|
1240
|
+
<ul>
|
|
1241
|
+
<li class="nobullet">
|
|
1242
|
+
<i class="material-icons">tab_unselected</i>
|
|
1243
|
+
<b>Regions:</b>
|
|
1244
|
+
</li>
|
|
1245
|
+
</ul>
|
|
1246
|
+
<div style="display: flex; flex-wrap: wrap">
|
|
1247
|
+
<div style="padding-left: 15px">
|
|
1248
|
+
Regions are map features that represent a bounded area on the
|
|
1249
|
+
map.<br />
|
|
1250
|
+
They can be attributed as hazardous areas which will create an
|
|
1251
|
+
alarm which will sound when the vessel position is inside the
|
|
1252
|
+
region's bounds. <br />
|
|
1253
|
+
To mark a regions as hazardous:
|
|
1254
|
+
<ul>
|
|
1255
|
+
<li>Click on the Region</li>
|
|
1256
|
+
<li>
|
|
1257
|
+
Select <i class="material-icons">info_outline</i><b>Info</b>
|
|
1258
|
+
</li>
|
|
1259
|
+
<li>Check <b>Hazardous Area</b></li>
|
|
1260
|
+
<li>Click <b>OK</b> to save.</li>
|
|
1261
|
+
</ul>
|
|
1262
|
+
</div>
|
|
1263
|
+
</div>
|
|
1238
1264
|
</div>
|
|
1239
1265
|
|
|
1240
1266
|
<div class="panel" id="gpxsave">
|
package/public/index.html
CHANGED
|
@@ -59,5 +59,5 @@
|
|
|
59
59
|
</div>
|
|
60
60
|
</div>
|
|
61
61
|
</app-root>
|
|
62
|
-
<script src="runtime.e598c35c8d15b7e2.js" type="module"></script><script src="polyfills.0823dc027f0a1d2e.js" type="module"></script><script src="main.
|
|
62
|
+
<script src="runtime.e598c35c8d15b7e2.js" type="module"></script><script src="polyfills.0823dc027f0a1d2e.js" type="module"></script><script src="main.bf1f82cf3703dabc.js" type="module"></script></body>
|
|
63
63
|
</html>
|