forked from SignalK/specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
keyswithmetadata.json
1535 lines (1535 loc) · 53.8 KB
/
keyswithmetadata.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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"/self": {
"description": "This holds the key (UUID, MMSI or URL) of this vessel, the actual data is in the vessels array."
},
"/vessels": {
"description": "A wrapper object for vessel objects, each describing vessels in range, including this vessel."
},
"/vessels/*": {
"description": "An object describing an individual vessel. It should be an object in vessels, named using MMSI or a UUID"
},
"/vessels/*/url": {
"description": "URL based identity of the vessel, if available."
},
"/vessels/*/mmsi": {
"description": "MMSI number of the vessel, if available."
},
"/vessels/*/uuid": {
"description": "A unique Signal K flavoured maritime resource identifier, assigned by the server."
},
"/vessels/*/name": {
"description": "The common name of the vessel"
},
"/vessels/*/flag": {
"description": "The country of ship registration, or flag state of the vessel"
},
"/vessels/*/port": {
"description": "The home port of the vessel"
},
"/vessels/*/registrations": {
"description": "The various registrations of the vessel."
},
"/vessels/*/registrations/imo": {
"description": "The IMO number of the vessel."
},
"/vessels/*/registrations/national": {
"description": "The national registration number of the vessel."
},
"/vessels/*/registrations/national/RegExp": {
"description": "This regex pattern is used for validating the identifier for the registration"
},
"/vessels/*/registrations/national/RegExp/country": {
"description": "The ISO 3166-2 country code."
},
"/vessels/*/registrations/national/RegExp/registration": {
"description": "The registration code"
},
"/vessels/*/registrations/national/RegExp/description": {
"description": "The registration description"
},
"/vessels/*/registrations/local": {
"description": "A local or state registration number of the vessel."
},
"/vessels/*/registrations/local/RegExp": {
"description": "This regex pattern is used for validating the identifier for the registration"
},
"/vessels/*/registrations/local/RegExp/registration": {
"description": "The registration code"
},
"/vessels/*/registrations/local/RegExp/description": {
"description": "The registration description"
},
"/vessels/*/registrations/other": {
"description": "Other registration or permits for the vessel."
},
"/vessels/*/registrations/other/RegExp": {
"description": "This regex pattern is used for validating the identifier for the registration"
},
"/vessels/*/registrations/other/RegExp/registration": {
"description": "The registration code"
},
"/vessels/*/registrations/other/RegExp/description": {
"description": "The registration description"
},
"/vessels/*/communication": {
"description": "Communication data including Radio, Telephone, E-Mail, etc."
},
"/vessels/*/communication/callsignVhf": {
"description": "Callsign for VHF communication"
},
"/vessels/*/communication/callsignHf": {
"description": "Callsign for HF communication"
},
"/vessels/*/communication/phoneNumber": {
"description": "Phone number of skipper"
},
"/vessels/*/communication/emailHf": {
"description": "Email address to be used for HF email (Winmail, Airmail, Sailmail)"
},
"/vessels/*/communication/email": {
"description": "Regular email for the skipper"
},
"/vessels/*/communication/satPhoneNumber": {
"description": "Satellite phone number for vessel."
},
"/vessels/*/communication/skipperName": {
"description": "Full name of the skipper of the vessel."
},
"/vessels/*/communication/crewNames": {
"description": "Array with the names of the crew"
},
"/vessels/*/environment": {
"description": "Environmental data measured locally including Depth, Wind, Temp, etc."
},
"/vessels/*/environment/outside": {
"description": "[missing]"
},
"/vessels/*/environment/outside/temperature": {
"units": "K",
"description": "Current outside air temperature"
},
"/vessels/*/environment/outside/dewPointTemperature": {
"units": "K",
"description": "Current outside dew point temperature"
},
"/vessels/*/environment/outside/apparentWindChillTemperature": {
"units": "K",
"description": "Current outside apparent wind chill temperature"
},
"/vessels/*/environment/outside/theoreticalWindChillTemperature": {
"units": "K",
"description": "Current outside theoretical wind chill temperature"
},
"/vessels/*/environment/outside/heatIndexTemperature": {
"units": "K",
"description": "Current outside heat index temperature"
},
"/vessels/*/environment/outside/pressure": {
"units": "Pa",
"description": "Current outside air ambient pressure"
},
"/vessels/*/environment/outside/humidity": {
"units": "ratio",
"description": "Current outside air relative humidity"
},
"/vessels/*/environment/inside": {
"description": "[missing]"
},
"/vessels/*/environment/inside/temperature": {
"units": "K",
"description": "Current inside air temperature"
},
"/vessels/*/environment/inside/humidity": {
"units": "ratio",
"description": "Current inside air relative humidity"
},
"/vessels/*/environment/inside/engineRoom": {
"description": "Current engine room air temperature"
},
"/vessels/*/environment/inside/engineRoom/temperature": {
"units": "K",
"description": "Temperature"
},
"/vessels/*/environment/inside/mainCabin": {
"description": "Current main cabin air temperature"
},
"/vessels/*/environment/inside/mainCabin/temperature": {
"units": "K",
"description": "Temperature"
},
"/vessels/*/environment/inside/refrigerator": {
"description": "Current refrigerator temperature"
},
"/vessels/*/environment/inside/refrigerator/temperature": {
"units": "K",
"description": "Temperature"
},
"/vessels/*/environment/inside/freezer": {
"description": "Current freezer temperature"
},
"/vessels/*/environment/inside/freezer/temperature": {
"units": "K",
"description": "Temperature"
},
"/vessels/*/environment/inside/heating": {
"description": "Current heating temperature"
},
"/vessels/*/environment/inside/heating/temperature": {
"units": "K",
"description": "Temperature"
},
"/vessels/*/environment/water": {
"description": "[missing]"
},
"/vessels/*/environment/water/temperature": {
"units": "K",
"description": "Current water temperature"
},
"/vessels/*/environment/water/salinity": {
"units": "ratio",
"description": "Water salinity"
},
"/vessels/*/environment/water/liveWell": {
"description": "Current livewell temperature"
},
"/vessels/*/environment/water/liveWell/temperature": {
"units": "K",
"description": "Temperature"
},
"/vessels/*/environment/water/baitWell": {
"description": "Current baitwell air temperature"
},
"/vessels/*/environment/water/baitWell/temperature": {
"units": "K",
"description": "Temperature"
},
"/vessels/*/environment/depth": {
"description": "Depth related data"
},
"/vessels/*/environment/depth/belowKeel": {
"units": "m",
"description": "Depth below keel"
},
"/vessels/*/environment/depth/belowTransducer": {
"units": "m",
"description": "Depth below Transducer"
},
"/vessels/*/environment/depth/belowSurface": {
"units": "m",
"description": "Depth from surface"
},
"/vessels/*/environment/depth/transducerToKeel": {
"units": "m",
"description": "Depth from the transducer to the bottom of the keel"
},
"/vessels/*/environment/depth/surfaceToTransducer": {
"units": "m",
"description": "Depth transducer is below the water surface"
},
"/vessels/*/environment/current": {
"description": "Direction and strength of current affecting the vessel"
},
"/vessels/*/environment/tide": {
"description": "Tide data"
},
"/vessels/*/environment/tide/heightHigh": {
"units": "m",
"description": "Next high tide height relative to lowest astronomical tide (LAT/Chart Datum)"
},
"/vessels/*/environment/tide/heightNow": {
"units": "m",
"description": "The current tide height relative to lowest astronomical tide (LAT/Chart Datum)"
},
"/vessels/*/environment/tide/heightLow": {
"units": "m",
"description": "The next low tide height relative to lowest astronomical tide (LAT/Chart Datum)"
},
"/vessels/*/environment/tide/timeLow": {
"units": "ISO-8601 (UTC)",
"description": "Time of the next low tide in UTC"
},
"/vessels/*/environment/tide/timeHigh": {
"units": "ISO-8601 (UTC)",
"description": "Time of next high tide in UTC"
},
"/vessels/*/environment/heave": {
"units": "m",
"description": "Vertical movement of the vessel due to waves"
},
"/vessels/*/environment/wind": {
"description": "Wind data."
},
"/vessels/*/environment/wind/angleApparent": {
"units": "rad",
"description": "Apparent wind angle, negative to port"
},
"/vessels/*/environment/wind/angleTrueGround": {
"units": "rad",
"description": "True wind angle based on speed over ground, negative to port"
},
"/vessels/*/environment/wind/angleTrueWater": {
"units": "rad",
"description": "True wind angle based on speed through water, negative to port"
},
"/vessels/*/environment/wind/directionChangeAlarm": {
"units": "rad",
"description": "The angle the wind needs to shift to raise an alarm"
},
"/vessels/*/environment/wind/directionTrue": {
"units": "rad",
"description": "The wind direction relative to true north"
},
"/vessels/*/environment/wind/directionMagnetic": {
"units": "rad",
"description": "The wind direction relative to magnetic north"
},
"/vessels/*/environment/wind/speedTrue": {
"units": "m/s",
"description": "Wind speed over water (as calculated from speedApparent and vessel's speed through water)"
},
"/vessels/*/environment/wind/speedOverGround": {
"units": "m/s",
"description": "Wind speed over ground (as calculated from speedApparent and vessel's speed over ground)"
},
"/vessels/*/environment/wind/speedApparent": {
"units": "m/s",
"description": "Apparent wind speed"
},
"/vessels/*/environment/time": {
"description": "A time reference onboard."
},
"/vessels/*/environment/time/millis": {
"description": "Milliseconds since the UNIX epoch (1970-01-01 00:00:00)"
},
"/vessels/*/environment/time/timezone": {
"description": "Timezone offset in hours and minutes (-)hhmm"
},
"/vessels/*/environment/mode": {
"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."
},
"/vessels/*/navigation": {
"description": "Navigation data including Position, Course to next WP information, etc."
},
"/vessels/*/navigation/lights": {
"description": "Current state of the vessels navigation lights"
},
"/vessels/*/navigation/courseOverGroundMagnetic": {
"units": "rad",
"description": "Course over ground (magnetic)"
},
"/vessels/*/navigation/courseOverGroundTrue": {
"units": "rad",
"description": "Course over ground (true)"
},
"/vessels/*/navigation/courseRhumbline": {
"description": "Course information computed with Rhumbline"
},
"/vessels/*/navigation/courseRhumbline/crossTrackError": {
"units": "m",
"description": "The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate)."
},
"/vessels/*/navigation/courseRhumbline/bearingTrackTrue": {
"units": "rad",
"description": "The bearing of a line between previousPoint and nextPoint, relative to true north."
},
"/vessels/*/navigation/courseRhumbline/bearingTrackMagnetic": {
"units": "rad",
"description": "The bearing of a line between previousPoint and nextPoint, relative to magnetic north."
},
"/vessels/*/navigation/courseRhumbline/activeRoute": {
"description": "[missing]"
},
"/vessels/*/navigation/courseRhumbline/activeRoute/href": {
"description": "A reference (URL) to the presently active route, in resources."
},
"/vessels/*/navigation/courseRhumbline/activeRoute/estimatedTimeOfArrival": {
"units": "ISO-8601 (UTC)",
"description": "The estimated time of arrival at the end of the current route"
},
"/vessels/*/navigation/courseRhumbline/activeRoute/startTime": {
"units": "ISO-8601 (UTC)",
"description": "The time this route was activated"
},
"/vessels/*/navigation/courseRhumbline/nextPoint": {
"description": "The point on earth the vessel's presently navigating towards"
},
"/vessels/*/navigation/courseRhumbline/previousPoint": {
"description": "The point on earth the vessel's presently navigating from"
},
"/vessels/*/navigation/courseGreatCircle": {
"description": "Course information computed with Great Circle"
},
"/vessels/*/navigation/courseGreatCircle/crossTrackError": {
"units": "m",
"description": "The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate)."
},
"/vessels/*/navigation/courseGreatCircle/bearingTrackTrue": {
"units": "rad",
"description": "The bearing of a line between previousPoint and nextPoint, relative to true north."
},
"/vessels/*/navigation/courseGreatCircle/bearingTrackMagnetic": {
"units": "rad",
"description": "The bearing of a line between previousPoint and nextPoint, relative to magnetic north."
},
"/vessels/*/navigation/courseGreatCircle/activeRoute": {
"description": "[missing]"
},
"/vessels/*/navigation/courseGreatCircle/activeRoute/href": {
"description": "A reference (URL) to the presently active route, in resources."
},
"/vessels/*/navigation/courseGreatCircle/activeRoute/estimatedTimeOfArrival": {
"units": "ISO-8601 (UTC)",
"description": "The estimated time of arrival at the end of the current route"
},
"/vessels/*/navigation/courseGreatCircle/activeRoute/startTime": {
"units": "ISO-8601 (UTC)",
"description": "The time this route was activated"
},
"/vessels/*/navigation/courseGreatCircle/nextPoint": {
"description": "The point on earth the vessel's presently navigating towards"
},
"/vessels/*/navigation/courseGreatCircle/previousPoint": {
"description": "The point on earth the vessel's presently navigating from"
},
"/vessels/*/navigation/racing": {
"description": "[missing]"
},
"/vessels/*/navigation/racing/startLineStb": {
"description": "[missing]"
},
"/vessels/*/navigation/racing/startLinePort": {
"description": "[missing]"
},
"/vessels/*/navigation/racing/distanceStartline": {
"units": "m",
"description": "The current distance to the start line"
},
"/vessels/*/navigation/racing/timeToStart": {
"units": "s",
"description": "Time left before start"
},
"/vessels/*/navigation/racing/timePortDown": {
"units": "s",
"description": "Time to arrive at the start line on port, turning downwind"
},
"/vessels/*/navigation/racing/timePortUp": {
"units": "s",
"description": "Time to arrive at the start line on port, turning upwind"
},
"/vessels/*/navigation/racing/timeStbdDown": {
"units": "s",
"description": "Time to arrive at the start line on starboard, turning downwind"
},
"/vessels/*/navigation/racing/timeStbdUp": {
"units": "s",
"description": "Time to arrive at the start line on starboard, turning upwind"
},
"/vessels/*/navigation/racing/distanceLayline": {
"units": "m",
"description": "The current distance to the layline"
},
"/vessels/*/navigation/magneticVariation": {
"units": "rad",
"description": "The magnetic variation (declination) at the current position"
},
"/vessels/*/navigation/magneticVariationAgeOfService": {
"units": "s",
"description": "Seconds since the 1st Jan 1970 that the variation calculation was made"
},
"/vessels/*/navigation/destination": {
"description": "The intended destination of this trip"
},
"/vessels/*/navigation/destination/eta": {
"units": "ISO-8601 (UTC)",
"description": "ISO-8601 (UTC) string representing date and time."
},
"/vessels/*/navigation/destination/waypoint": {
"description": "UUID of destination waypoint"
},
"/vessels/*/navigation/gnss": {
"description": "Global satellite navigation meta information"
},
"/vessels/*/navigation/gnss/methodQuality": {
"description": "Quality of the satellite fix"
},
"/vessels/*/navigation/gnss/integrity": {
"description": "Integrity of the satellite fix"
},
"/vessels/*/navigation/gnss/satellites": {
"description": "Number of satellites"
},
"/vessels/*/navigation/gnss/antennaAltitude": {
"units": "m",
"description": "Altitude of antenna"
},
"/vessels/*/navigation/gnss/horizontalDilution": {
"description": "Horizontal Dilution of Precision"
},
"/vessels/*/navigation/gnss/positionDilution": {
"description": "Positional Dilution of Precision"
},
"/vessels/*/navigation/gnss/geoidalSeparation": {
"description": "Difference between WGS84 earth ellipsoid and mean sea level"
},
"/vessels/*/navigation/gnss/differentialAge": {
"units": "s",
"description": "Age of DGPS data"
},
"/vessels/*/navigation/gnss/differentialReference": {
"description": "ID of DGPS base station"
},
"/vessels/*/navigation/headingMagnetic": {
"units": "rad",
"description": "Current magnetic heading of the vessel"
},
"/vessels/*/navigation/headingTrue": {
"units": "rad",
"description": "The current true heading of the vessel"
},
"/vessels/*/navigation/position": {
"description": "The position of the vessel in 2 or 3 dimensions (WGS84 datum)"
},
"/vessels/*/navigation/attitude": {
"description": "Vessel attitude: roll, pitch and yaw"
},
"/vessels/*/navigation/rateOfTurn": {
"units": "rad/s",
"description": "Rate of turn (+ve is change to starboard)"
},
"/vessels/*/navigation/speedOverGround": {
"units": "m/s",
"description": "Vessel speed over ground"
},
"/vessels/*/navigation/speedThroughWater": {
"units": "m/s",
"description": "Vessel speed through the water"
},
"/vessels/*/navigation/log": {
"units": "m",
"description": "Log value"
},
"/vessels/*/navigation/logTrip": {
"units": "m",
"description": "Trip log value"
},
"/vessels/*/navigation/state": {
"description": "Current navigational state of the vessel"
},
"/vessels/*/navigation/anchor": {
"description": "The anchor data, for anchor watch etc"
},
"/vessels/*/navigation/anchor/maxRadius": {
"units": "m",
"description": "Radius of anchor alarm boundary. The distance from anchor to the center of the boat"
},
"/vessels/*/navigation/anchor/currentRadius": {
"units": "m",
"description": "Current distance to anchor"
},
"/vessels/*/navigation/anchor/position": {
"description": "The actual anchor position of the vessel in 3 dimensions, probably an estimate at best"
},
"/vessels/*/navigation/datetime": {
"description": "[missing]"
},
"/vessels/*/propulsion": {
"description": "Engine data, each engine identified by a unique name i.e. Port_Engine"
},
"/vessels/*/propulsion/RegExp": {
"description": "This regex pattern is used for validation of the identifier for the propulsion unit"
},
"/vessels/*/propulsion/RegExp/label": {
"description": "Human readable label for the propulsion unit"
},
"/vessels/*/propulsion/RegExp/state": {
"description": "The current state of the engine"
},
"/vessels/*/propulsion/RegExp/revolutions": {
"units": "Hz",
"description": "Engine revolutions (x60 for RPM)"
},
"/vessels/*/propulsion/RegExp/temperature": {
"units": "K",
"description": "Engine temperature"
},
"/vessels/*/propulsion/RegExp/oilTemperature": {
"units": "K",
"description": "Oil temperature"
},
"/vessels/*/propulsion/RegExp/oilPressure": {
"units": "Pa",
"description": "Oil pressure"
},
"/vessels/*/propulsion/RegExp/alternatorVoltage": {
"units": "V",
"description": "Alternator voltage"
},
"/vessels/*/propulsion/RegExp/runTime": {
"units": "s",
"description": "Total running time for engine (Engine Hours in seconds)"
},
"/vessels/*/propulsion/RegExp/coolantTemperature": {
"units": "K",
"description": "Coolant temperature"
},
"/vessels/*/propulsion/RegExp/coolantPressure": {
"units": "Pa",
"description": "Coolant pressure"
},
"/vessels/*/propulsion/RegExp/boostPressure": {
"units": "Pa",
"description": "Engine boost (turbo, supercharger) pressure"
},
"/vessels/*/propulsion/RegExp/engineLoad": {
"units": "ratio",
"description": "Engine load ratio, 0<=ratio<=1, 1 is 100%"
},
"/vessels/*/propulsion/RegExp/engineTorque": {
"units": "ratio",
"description": "Engine torque ratio, 0<=ratio<=1, 1 is 100%"
},
"/vessels/*/propulsion/RegExp/transmission": {
"description": "[missing]"
},
"/vessels/*/propulsion/RegExp/transmission/gear": {
"description": "[missing]"
},
"/vessels/*/propulsion/RegExp/transmission/gearRatio": {
"units": "ratio",
"description": "Gear ratio, engine rotations per propeller shaft rotation"
},
"/vessels/*/propulsion/RegExp/transmission/oilTemperature": {
"units": "K",
"description": "Oil temperature"
},
"/vessels/*/propulsion/RegExp/transmission/oilPressure": {
"units": "Pa",
"description": "Oil pressure"
},
"/vessels/*/propulsion/RegExp/drive": {
"description": "[missing]"
},
"/vessels/*/propulsion/RegExp/drive/type": {
"description": "[missing]"
},
"/vessels/*/propulsion/RegExp/drive/trimState": {
"units": "ratio",
"description": "Trim/tilt state, 0<=ratio<=1, 1 is 100% up"
},
"/vessels/*/propulsion/RegExp/drive/thrustAngle": {
"units": "rad",
"description": "Current thrust angle for steerable drives, +ve is thrust to Starboard"
},
"/vessels/*/propulsion/RegExp/drive/propeller": {
"description": "[missing]"
},
"/vessels/*/propulsion/RegExp/fuel": {
"description": "[missing]"
},
"/vessels/*/propulsion/RegExp/fuel/type": {
"description": "Fuel type"
},
"/vessels/*/propulsion/RegExp/fuel/used": {
"units": "m3",
"description": "Used fuel since last reset. Resetting is at user discretion"
},
"/vessels/*/propulsion/RegExp/fuel/pressure": {
"units": "Pa",
"description": "Fuel pressure"
},
"/vessels/*/propulsion/RegExp/fuel/rate": {
"units": "m3/s",
"description": "Fuel rate of consumption"
},
"/vessels/*/propulsion/RegExp/fuel/economyRate": {
"units": "m3/s",
"description": "Economy fuel rate of consumption"
},
"/vessels/*/propulsion/RegExp/fuel/averageRate": {
"units": "m3/s",
"description": "Average fuel rate of consumption"
},
"/vessels/*/propulsion/RegExp/exhaustTemperature": {
"units": "K",
"description": "Exhaust temperature"
},
"/vessels/*/electrical": {
"description": "Electrical data, each electrical device indentified by a unique name i.e. Battery_1"
},
"/vessels/*/electrical/batteries": {
"description": "[missing]"
},
"/vessels/*/electrical/batteries/RegExp": {
"description": "Batteries, one or many, within the vessel"
},
"/vessels/*/electrical/batteries/RegExp/associatedBus": {
"description": "Name of BUS device is associated with"
},
"/vessels/*/electrical/batteries/RegExp/voltage": {
"units": "V",
"description": "[missing]"
},
"/vessels/*/electrical/batteries/RegExp/current": {
"units": "A",
"description": "[missing]"
},
"/vessels/*/electrical/batteries/RegExp/temperature": {
"description": "Additional / unique temperatures associated with a battery"
},
"/vessels/*/electrical/batteries/RegExp/temperature/limitDischargeLower": {
"units": "K",
"description": "Operational minimum temperature limit for battery discharge"
},
"/vessels/*/electrical/batteries/RegExp/temperature/limitDischargeUpper": {
"units": "K",
"description": "Operational maximum temperature limit for battery discharge"
},
"/vessels/*/electrical/batteries/RegExp/temperature/limitRechargeLower": {
"units": "K",
"description": "Operational minimum temperature limit for battery recharging"
},
"/vessels/*/electrical/batteries/RegExp/temperature/limitRechargeUpper": {
"units": "K",
"description": "Operational maximum temperature limit for battery recharging"
},
"/vessels/*/electrical/batteries/RegExp/capacity": {
"description": "[missing]"
},
"/vessels/*/electrical/batteries/RegExp/capacity/nominal": {
"units": "J",
"description": "The capacity of battery as specified by the manufacturer"
},
"/vessels/*/electrical/batteries/RegExp/capacity/actual": {
"units": "J",
"description": "The measured capacity of battery. This may change over time and will likely deviate from the nominal capacity."
},
"/vessels/*/electrical/batteries/RegExp/capacity/remaining": {
"units": "J",
"description": "Capacity remaining in battery"
},
"/vessels/*/electrical/batteries/RegExp/capacity/dischargeLimit": {
"units": "J",
"description": "Minimum capacity to be left in the battery while discharging"
},
"/vessels/*/electrical/batteries/RegExp/capacity/stateOfCharge": {
"units": "ratio",
"description": "State of charge, 1 = 100%"
},
"/vessels/*/electrical/batteries/RegExp/capacity/stateOfHealth": {
"units": "ratio",
"description": "State of Health, 1 = 100%"
},
"/vessels/*/electrical/batteries/RegExp/capacity/dischargeSinceFull": {
"units": "C",
"description": "Cumulative discharge since battery was last full"
},
"/vessels/*/electrical/batteries/RegExp/capacity/timeRemaining": {
"units": "s",
"description": "Time to discharge to discharge limit at current rate"
},
"/vessels/*/electrical/batteries/RegExp/lifetimeDischarge": {
"units": "C",
"description": "Cumulative charge discharged from battery over operational lifetime of battery"
},
"/vessels/*/electrical/batteries/RegExp/lifetimeRecharge": {
"units": "C",
"description": "Cumulative charge recharged into battery over operational lifetime of battery"
},
"/vessels/*/electrical/inverters": {
"description": "[missing]"
},
"/vessels/*/electrical/inverters/RegExp": {
"description": "DC to AC inverter, one or many, within the vessel"
},
"/vessels/*/electrical/inverters/RegExp/dc": {
"description": "DC common quantities"
},
"/vessels/*/electrical/inverters/RegExp/dc/associatedBus": {
"description": "Name of BUS device is associated with"
},
"/vessels/*/electrical/inverters/RegExp/dc/voltage": {
"units": "V",
"description": "[missing]"
},
"/vessels/*/electrical/inverters/RegExp/dc/current": {
"units": "A",
"description": "[missing]"
},
"/vessels/*/electrical/inverters/RegExp/dc/temperature": {
"description": "[missing]"
},
"/vessels/*/electrical/inverters/RegExp/ac": {
"description": "AC equipment common quantities"
},
"/vessels/*/electrical/inverters/RegExp/ac/associatedBus": {
"description": "Name of BUS source is assocated with (if applicable, may = NULL)"
},
"/vessels/*/electrical/inverters/RegExp/ac/lineNeutralVoltage": {
"units": "V",
"description": "RMS voltage measured between phase and neutral."
},
"/vessels/*/electrical/inverters/RegExp/ac/lineLineVoltage": {
"units": "V",
"description": "RMS voltage measured between phases"
},
"/vessels/*/electrical/inverters/RegExp/ac/current": {
"units": "A",
"description": "RMS current"
},
"/vessels/*/electrical/inverters/RegExp/ac/frequency": {
"units": "Hz",
"description": "AC frequency."
},
"/vessels/*/electrical/inverters/RegExp/ac/reactivePower": {
"units": "W",
"description": "Reactive power"
},
"/vessels/*/electrical/inverters/RegExp/ac/powerFactor": {
"description": "Power factor"
},
"/vessels/*/electrical/inverters/RegExp/ac/powerFactorLagging": {
"description": "Lead/lag status."
},
"/vessels/*/electrical/inverters/RegExp/ac/realPower": {
"units": "W",
"description": "Real power."
},
"/vessels/*/electrical/inverters/RegExp/ac/apparentPower": {
"units": "W",
"description": "Apparent power."
},
"/vessels/*/electrical/inverters/RegExp/mode": {
"description": "Mode of inverter"
},
"/vessels/*/electrical/chargers": {
"description": "[missing]"
},
"/vessels/*/electrical/chargers/RegExp": {
"description": "Battery charger"
},
"/vessels/*/electrical/chargers/RegExp/associatedBus": {
"description": "Name of BUS device is associated with"
},
"/vessels/*/electrical/chargers/RegExp/voltage": {
"units": "V",
"description": "[missing]"
},
"/vessels/*/electrical/chargers/RegExp/current": {
"units": "A",
"description": "[missing]"
},
"/vessels/*/electrical/chargers/RegExp/temperature": {
"description": "[missing]"
},
"/vessels/*/electrical/chargers/RegExp/mode": {
"description": "[missing]"
},
"/vessels/*/electrical/ac": {
"description": "AC buses"
},
"/vessels/*/electrical/ac/RegExp": {
"description": "[missing]"
},
"/vessels/*/electrical/ac/RegExp/phase": {
"description": "[missing]"
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])": {
"description": "AC equipment common quantities"
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/associatedBus": {
"description": "Name of BUS source is assocated with (if applicable, may = NULL)"
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/lineNeutralVoltage": {
"units": "V",
"description": "RMS voltage measured between phase and neutral."
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/lineLineVoltage": {
"units": "V",
"description": "RMS voltage measured between phases"
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/current": {
"units": "A",
"description": "RMS current"
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/frequency": {
"units": "Hz",
"description": "AC frequency."
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/reactivePower": {
"units": "W",
"description": "Reactive power"
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/powerFactor": {
"description": "Power factor"
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/powerFactorLagging": {
"description": "Lead/lag status."
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/realPower": {
"units": "W",
"description": "Real power."
},
"/vessels/*/electrical/ac/RegExp/phase/(single)|([A-C])/apparentPower": {
"units": "W",
"description": "Apparent power."
},
"/vessels/*/notifications": {
"description": "Notifications currently raised. Major categories have well-defined names, but the tree can be extended by any hierarchical structure"
},
"/vessels/*/notifications/mob": {
"description": "Man overboard"
},
"/vessels/*/notifications/mob/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/fire": {
"description": "Fire onboard"
},
"/vessels/*/notifications/fire/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/sinking": {
"description": "Vessel is sinking"
},
"/vessels/*/notifications/sinking/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/flooding": {
"description": "Vessel is flooding"
},
"/vessels/*/notifications/flooding/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/collision": {
"description": "In collision with another vessel or object"
},
"/vessels/*/notifications/collision/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/grounding": {
"description": "Vessel grounding"
},
"/vessels/*/notifications/grounding/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/listing": {
"description": "Vessel is listing"
},
"/vessels/*/notifications/listing/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/adrift": {
"description": "Vessel is adrift"
},
"/vessels/*/notifications/adrift/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/piracy": {
"description": "Under attack or danger from pirates"
},
"/vessels/*/notifications/piracy/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/abandon": {
"description": "Abandon ship"
},
"/vessels/*/notifications/abandon/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/notifications/RegExp": {
"description": "Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array."
},
"/vessels/*/notifications/RegExp/RegExp": {
"description": "Reference to the source under /sources. A dot spearated path to the data. eg [type].[bus].[device]"
},
"/vessels/*/steering": {
"description": "Vessel steering data for steering controls (not Autopilot 'Nav Data')"
},
"/vessels/*/steering/rudderAngle": {
"units": "rad",
"description": "Current rudder angle, +ve is rudder to Starboard"
},
"/vessels/*/steering/rudderAngleTarget": {
"units": "rad",
"description": "The angle the rudder should move to, +ve is rudder to Starboard"
},
"/vessels/*/steering/autopilot": {
"description": "Autopilot data"
},
"/vessels/*/steering/autopilot/state": {
"description": "Autopilot state"
},
"/vessels/*/steering/autopilot/mode": {
"description": "Operational mode"
},
"/vessels/*/steering/autopilot/target": {
"description": "Autopilot target"
},
"/vessels/*/steering/autopilot/target/angle": {
"units": "rad",
"description": "Target heading for autopilot, relative to magnetic North or Apparent wind +port -starboard"
},
"/vessels/*/steering/autopilot/target/reference": {
"description": "Current source of heading information"
},
"/vessels/*/steering/autopilot/deadZone": {
"units": "rad",
"description": "Dead zone to ignore for rudder corrections"
},
"/vessels/*/steering/autopilot/backlash": {
"units": "rad",
"description": "Slack in the rudder drive mechanism"
},
"/vessels/*/steering/autopilot/gain": {
"description": "Auto-pilot gain, higher number equals more rudder movement for a given turn"
},
"/vessels/*/steering/autopilot/maxDriveCurrent": {
"units": "A",
"description": "Maximum current to use to drive servo"
},
"/vessels/*/steering/autopilot/maxDriveRate": {
"units": "rad/s",
"description": "Maximum rudder rotation speed"
},
"/vessels/*/steering/autopilot/portLock": {
"units": "rad",
"description": "Position of servo on port lock"
},
"/vessels/*/steering/autopilot/starboardLock": {
"units": "rad",
"description": "Position of servo on starboard lock"