table of contents - signal ksignalk.org/specification/1.0.4/doc/signalk.pdf · position –...

1.1

1.2

1.2.1

1.2.2

1.3

1.3.1

1.3.2

1.3.3

1.3.4

1.4

1.4.1

1.4.2

1.4.3

1.4.4

1.4.5

1.4.6

1.5

1.6

1.7

1.8

1.9

TableofContentsSignalKSpecification

GettingStarted

UsingSK

DevelopingwithSK

DataModel

FullandDeltaModels

MultipleValues

Metadata

Sources

API

URLsandPorts

RESTAPI

StreamingWebSocketAPI

SubscriptionProtocol

Discovery&ConnectionEstablishment

Notifications

HowCanIHelp?

AppendixA:KeysReference(Vessel)

AppendixB:KeysReference(Others)

AppendixC:Changelog

AppendixD:Versioning

1

IntroductionThisisthedocumentationfortheSignalKSpecification1.0.4version,whichisavailableinthefollowingformats;

html(thisdocument)1.0.4pdfepubmobi

WhatisSignalK?

SignalKisamodernandopendataformatformarineuse.ItisanInternetfriendlystandardbuiltoncommonwebtechnologies,suchasJSONandWebSockets.SignalKisFreeandOpenSourcesoftware.ThisdocumentislicensedundertheCreativeCommonsCC-BY-SAlicense.AllSignalKsourcecodeislicensedundertheApacheLicense,Version2.0.SignalKisdevelopedintheopenwithhelpfromthemarinecommunity.Yourideasandfeedbackarevaluableandwelcome.

SignalKisdesignedtoworkinharmonywithaboat’sexistingnavigationequipmentwhichmayuseNMEA0183,NMEA2000orproprietarydataprotocols,convertingandenhancingthisinformationintoamodern“webfriendly”formatwhichcanbeshared,processedanddisplayedonthelatestwebapps,mobiledevicesandcloudservers.AtypicalNMEAbasedinstallationconsistsofanNMEAtoSignalKgatewayandanoptionalSignalKserver.ThegatewaytranslatesNMEAdataintoSignalKformatandtheservercanhostadditionalfunctionslikelogging,cloudintegrationanddataanalysis.

SignalKSpecification

2

https://github.com/signalk/specification

http://signalk.org/specification/1.0.4/

http://signalk.org/specification/1.0.4/signalk.pdf

http://signalk.org/specification/1.0.4/signalk.epub

http://signalk.org/specification/1.0.4/signalk.mobi

https://creativecommons.org/licenses/by-sa/4.0/

https://www.apache.org/licenses/LICENSE-2.0

OnemajoradvantageofSignalKistheabilitytorepresentdatafromheterogeneoussources.InadditiontotraditionalNMEAsources,datafromgenericsensorsaswellasmodernSignalKenabledsensorscanbefusedintoasingledatamodelandasingleprotocolforaccessingthedata.AnothertypicalconfigurationisaSignalKserverwithadaptersandconvertersforthedifferentsources.


3

SignalKDataModel(A.K.A.TheSchema)

TheSignalKDataModelorschemadefinesauniversalmodelformarinerelatedinformationanditisspecifiedasaJSONschema.SeetheSignalKDataModelsectionfordetails.

Intraditionalmarinestandardstherearemanytightlydefinedmessages,eachwithaspecificpurpose,butthereisnodatamodeltorelatethem.Furthermore,anydevicewhichneedstodecodethosemessagesmusthaveacopyofthedatadictionaryinordertodoso.BydefiningadatamodelinJSONwecanmakethemessaginglayersimplerandeasilyextensible.Wedefineconsistentunitsandmetadataforeachdatapointinthemodel.Thismeansthataspecificdatapoint(e.g.COG)willalwaysbefoundatapredictableaddress.

ItalsomeansthatadisplaydevicesuchasachartplotterimplementingSignalKdoesnotneedtoknowaboutthedatamodelbeforehand.ItcanquerythecentralSignalKserverontheboattogetalltheinformationitneedstodisplayanydatapoint.Thismetadatamayincludeinformationsuchastheunitofmeasure,minimumandmaximumpermissiblevalues,alarmthresholdsandlocalizeddisplaynameforeverydatapointinthemodel.

SignalKMessageFormat


4

SignalKdefinesmethodsforcombiningarbitrarydatafromtheDataModelintovalidmessages.ThesemessagesareinUTF-8JSONformat.

Ratherthandefinehundredsofspecificmessages,SignalKhasafewcommonmessageformatswhichcancontainanycombinationofdatafromtheDataModel.Thismeansthatthereisnoneedtodefinenewmessagesforeverynewdatapointorcommandwhichneedstobesupported,ratherthemessageformatremainsthesameandonlythedatatransmittedneedstochange.Itmeansthatanydevicecanreadanymessageandadevicecanintroduceanewdatapointwhichcanbeunderstoodbyexistingdeviceswithouttheneedforfirmwareupgrades.

SignalKTransportLayer

SignalKdoesnotdefinethetransportorwireprotocol.SignalKmessagesareJSONtextandcanbesentoveralmostanyphysicaltransportlayer.However,theSignalKstandarddoesprovideguidanceonhowtoestablishaninitialconnection,handlenegotiation,subscription,anddisconnectionforagiventransport(e.g.TCP/IPorserial).

WherepossibleSignalKuseswellestablishedstandardslikeHTTPS,REST,andWebSockets.However,theseshouldnotbeinterpretedasrequireddependenciesofSignalK.Itisentirelypossibleandpermissibletoimplementtheprotocoloveranytransportthatyourimplementationrequires.

Thegoalistotrytoestablishsensibleconventionsforeachtransportinordertomakedevelopmentandinterconnectionmorepredictable.

SignalKImplementations

TheSignalKprojecthasOpenSourcereferenceserverimplementationsinNodeandJava.TherearealsoseveralwebappsprovidedbytheprojectwhichcanbeinstalleddirectlyintheNodeandJavaserversordownloadedfromSignalKGitHub.TherearealsocommercialSignalKapplicationsandsolutions,includingmobileappsavailableontheAppleAppandAndroidPlayStores,aswellashardwareproductslikeiKommunicate.


5

https://github.com/SignalK/signalk-server-node

https://github.com/SignalK/signalk-server-java

https://github.com/SignalK

http://signalk.org/applications_solutions.html

http://ikommunicate.com/

GettingStartedUsingSignalKYoucanstartusingSignalKby

connectingtothedemoserverontheInternetwithanywebbrowserinstallingeithertheNodeorJavaserveronanycomputergettingsomehardwareforyourboat,suchasaRaspberryPi,suitableUSBadaptersforyourboat’snetwork(NMEA0183,NMEA2000orrollyourownwithI2Csensors)andinstallingtheNodeorJavaserverpurchasingacommercialSignalKgatewaysuchasaniKommunicatebyDigitalYachtinstallingOpenPlotter,whichincludesaSignalKserver

Onceyouhaveaserverrunning(oryoustartbyusingthedemoserver)youcaninstallsomeSignalKsupportingmobileappssuchas

WilhelmSKbyScottBender(iOS)NMEARemotebyZapfware(iOS)OceanIX(Android)

UsingSK

6

http://demo.signalk.org/

https://github.com/signalk/signalk-server-node

https://github.com/signalk/signalk-server-java

https://en.wikipedia.org/wiki/Raspberry_Pi

http://digitalyacht.co.uk/product/usb-nmea-adaptor/

http://www.actisense.com/product/nmea-2000-to-pc-interface-ngt-1/

https://en.wikipedia.org/wiki/I%C2%B2C

https://ikommunicate.com

http://www.sailoog.com/en/openplotter

https://www.wilhelmsk.com/

http://www.zapfware.de/en/products/nmearemote/

https://play.google.com/store/apps/details?id=com.easybizness.oceanIX

GettingStartedinDevelopingwithSignalKExampleHTML5ApplicationsSignalKJavaScriptClientiKommunicateDeveloper’sGuide

DevelopingwithSK

7

https://github.com/SignalK/signalk-server-node/tree/master/public/examples

https://github.com/SignalK/signalk-js-client

https://github.com/digitalyacht/ikommunicate/wiki/iKommunicate-Developer%27s-Guide-%28SDK%29

SignalKDataModel

Formats

SignalKdefinestwodataformats—fullanddelta—forrepresentingandtransmittingdata.AllSignalKdataistransmittedasUTF-8JSON.

FullFormat

ThefullformatisconceptuallythesimplestrepresentationofdatainSignalK.ItcontainsallofthedatafromaSignalKnode,whichinthecaseofaSignalKservercouldmemanyhundredsofdatapoints.

{

"version":"1.0.0",

"self":"urn:mrn:signalk:uuid:705f5f1a-efaf-44aa-9cb8-a0fd6305567c",

"vessels":{

"urn:mrn:signalk:uuid:705f5f1a-efaf-44aa-9cb8-a0fd6305567c":{

"navigation":{

"speedOverGround":{

"value":4.32693662,

"$source":"ttyUSB0.GP",

"sentence":"RMC",

"timestamp":"2017-05-16T05:15:50.007Z"

},

"position":{

"value":{

"altitude":0.0,

"latitude":37.81479,

"longitude":-122.44880152

},


"sentence":"RMC",

"timestamp":"2017-05-16T05:15:50.007Z"

},

"headingMagnetic":{

"value":5.55014702,

"$source":"ttyUSB0.II",

"sentence":"HDM",

"timestamp":"2017-05-16T05:15:54.006Z"

}

},

"name":"Motu",

"uuid":"urn:mrn:signalk:uuid:705f5f1a-efaf-44aa-9cb8-a0fd6305567c"

}

},

"sources":{

"ttyUSB0":{

"label":"ttyUSB0",

"type":"NMEA0183",

"GP":{

"talker":"GP",

"sentences":{

"RMC":"2017-04-03T06:14:04.451Z"

}

},

"II":{

"talker":"II",

"sentences":{

"HDM":"2017-05-16T05:15:54.006Z"

}

FullandDeltaModels

8

}

}

}

}

Thereareseveraltoplevelattributesorkeyswhicharealwayspresentandotherswhichareoptional.TheversionkeyspecifieswhichversionoftheSignalKspecificationisbeingusedandmustalwayspresentinafullSignalKmodel.Alsoalwayspresentinthefullmodelistheselfkey.Thevalueofselfisthekeywithinthevesselsobjectwhichisthelocalboat.Effectively,itisapointerintothevesselsobject.

Belowthevesselsobjectisalistofvessels,identifiedbytheirMMSInumberoragenerateduniqueID.TheremaybemanyvesselsifdatahasbeenreceivedfromAISorothersources.Theformatforeachvessel’sdatausesthesamestandardSignalKstructurebutmaynothavethesamecontent;likelyyouwillnothaveasmuchdataaboutothervesselsasyouhaveaboutyourown.

Atthesamelevelasvesselsissources.Thiscontainsalistofsourcesthedatawasobtainedfrom.Eachdataobjectwithinavesselmayhavea$sourcekeywhichpointtoasourcewithinsources.SeveraldataobjectsmayreferencethesamesourcesinceasingleNMEAsentenceorPGNmaymaptomultiplekeysinSignalK.

Alternativelythesourcedatamaybeembeddeddirectlyinplaceofthe$sourcebyusingthesourcekey:

{

"vessels":{


"navigation":{

"position":{

"value":{

"altitude":0.0,

"latitude":37.81479,

"longitude":-122.44880152

},

"source":{

"label":"ttyUSB0",

"type":"NMEA0183",

"talker":"GP",

"sentence":"PRMC"

},

"timestamp":"2017-05-16T05:15:50.007Z"

}

}

}

}

}

Formoreinformationonsources,seethesourcessection.

DataobjectsinSignalKareorganizedhierarchically,forexampledatarelatedtonavigationsuchasposition,speedthroughwaterandheadingareallorganizedunderanavigationsub-topicwithinthevesselobject.Eachdataobjecthasavaluepropertywhichholdstheactualvalueforthatspecifickey.Thevaluepropertymaycontainanumber,astringoranotherobject.SignalKkeysthatareobjectvaluedareobjectvaluedbecausethevaluesdon‘thavemuchsemanticmeaningindividually.Forexampleposition–latitudedoesn‘thavemuchmeaningwithoutanassociatedlongitude.Therefore,these(andaltitude)aregroupedtogetherinasinglenavigation.positionkey.

ThevaluesarealwaysSIunits,andalwaysthesameunitsforthesamekey.Therefore,speedOverGroundisalwaysmeterspersecond,neverknots,km/hr,ormiles/hr.Thismeansyouneverhavetosendunitswithdata,theunitsarespecificforakey,anddefinedinthedataschema.AsimplifiedversionoftheJSONschemawiththeunitsisavailableinKeysReferenceinAppendixA.Theunitsarealsoalwaysspecifiedinthevalues’metadatawhichisavailableviatheRESTAPIinthemeta.unitsproperty.Besidestheunitsproperty,metaprovidesalotofotherusefulinformationforconsumersofthedata.

FullandDeltaModels

9

Finally,eachdataobjectalsohasatimestamppropertywhichrepresentsthetimethatthevaluewasmeasured.TimestampsareinISO8601format–specificallytheRFC3339extensionformat,whichisslightlymorestrictthantheISOspecification.Forinstance,itrequiresfourdigityearsandspecifiesthatTisusedasaseparatorbetweenthedataandtimeportionsofthetimestamp.

Theorderingofkeysisalsonotimportant,theycanoccurinanyorder.Infact,ifyouaredesigningadevicewhichconsumesSignalKdata,itisimportanttorememberthattheJSONstandarddoesnotguaranteetheorderofpropertiesinanobject.YouMUSTNOTrelyonthedatayoureceivetoalwaysbeinthesameorderwithinaSignalKmessage.

ThefullformatismostusefulforgettingtheinitialstateofaSignalKsystem,forexamplewhenadisplaydevicefirstconnectstothenetworkorforrefreshingadevice‘sstatewhenitlosesanetworkconnection.

HoweversendingthefulldatamodeliswastefulofbothbandwidthandCPU,especiallywhenthereisalargeamountofavailabledata,ortheconsumingdeviceisonlyinterestedinasmallportionofit.Inthemajorityofcases,itispreferabletoonlyexchangesmall,specificportionsofthedata.

DeltaFormat

Byfar,themostcommonlyproducedSignalKformatisthedeltaformat.Conceptually,thedeltaisanupdatetoanexistingSignalKdatamodel.AdeviceconsumingdeltascouldeitherbuildupaviewoftheSignalKfulltreebyconsumingandcombiningdeltasoritcouldrequestfromaSignalKserverthecurrentfulltreemodelandapplydeltastothatastheyarereceived.ItisalsoentirelypossibleforadevicetoremainessentiallystatelessandtreatSignalKdeltasasindependentpacketsofdata,muchthesamewayasitwouldhandleNMEAsentencesorPGNs.

Anexampledeltamessageispresentedbelow.

{

"context":"vessels.urn:mrn:imo:mmsi:234567890",

"updates":[

{

"source":{

"label":"N2000-01",

"type":"NMEA2000",

"src":"017",

"pgn":127488

},

"timestamp":"2010-01-07T07:18:44Z",

"values":[

{

"path":"propulsion.0.revolutions",

"value":16.341667

},

{

"path":"propulsion.0.boostPressure",

"value":45500

}

]

}

]

}

Thetoplevelofadeltamessagecontainsanupdatespropertyandanoptionalcontextproperty.

{


"updates":[...]

}

FullandDeltaModels

10

https://tools.ietf.org/html/rfc3339

TheoptionalcontextpropertyrootstheupdatestoaparticularlocationintheSignalKtree.Ifcontextismissingitisassumedthatthedataisrelatedtotheselfcontext.Theselfcontextisthevesselobjectwhichtheselfpropertyofthefullmodelpointsto.

Contextisapathfromtherootofthefulltreetothecontainerobject,whichforvesselrelateddatamustrefertoavesseldirectlyundervessels.Thedelimiterinthecontextpathis.(period).Inthiscasethecontextisvessels.urn:mrn:imo:mmsi:234567890.Allsubsequentdataisrelativetothatlocation.

TheupdatespropertyholdsaJSONarrayofupdateobjects,eachofwhichmayhaveasourceproperty,atimestamppropertyandanarrayofvaluescontainingoneormorevalueobjects.

{

"source":{

"label":"N2000-01",

"type":"NMEA2000",

"src":"115",

"pgn":128267

},

"timestamp":"2014-08-15T16:00:00.081Z",

"values":[

{

"path":"navigation.courseOverGroundTrue",

"value":2.971

},

{

"path":"navigation.speedOverGround",

"value":3.85

}

]

}

Anupdatehasasinglesourcevalueanditappliestoeachofthevaluesitems.Incaseswheredatacanonlycomefromasinglesource,suchasanNMEA0183talkerconnectedtoaserialport,thenthesourcemaybeomitted.However,ifthedeltaisbeingpassedonbyaSignalKserverormultiplexerthensourcemustbefilledinbytheserversothatdownstreamconsumerscandiscernwheretheupdatecomesfrom.

IncaseswhereaSignalKproducerdoesnothaveaccesstoarealtimeclockorGPStimethentimestampshouldbeomitted.ElementsintheSignalKprocessingchain-suchasaserverreceivingdatafromaproducer-shouldfillintimestampifitismissingintheincomingdeltamessage.

Eachvalueitemisthensimplyapairofpathandvalue.Thepathmustbealeafpath:itmustbeapathtoaleaftheofthefullmodel.AleafiswheretheactualvalueoftheSignalKpropertyisandwheretimestamp,$sourceandvaluespropertiesareinthefullmodel.Thevalueisoftenascalar-asinglenumericvalue,asintheexampleabove-butitcanalsobeanobject.Forexampleanavigation.positionvaluewouldbeanobjectlike{"latitude":-41.2936935424,"longitude":173.2470855712}.

Therearesomestaticpropertiesinthefullmodelthatlackthesupportformultiplevaluesandmetadatasuchassourceandtimestamp.Anexampleisavessel‘sname,directlyunderthevessel‘sroot.Thisstaticdatamayappearinthedeltastream,forexamplewhenreceivedinAIStransmission.Inthiscasethevalueshouldbethesubtreeofthefullmodel,startingfromthevessel'sroot,withjusttherelevantparts,andthepathmustbeempty,indicatingthatthevalueshouldbemergedtothefullmodelmountedwherethedelta‘scontextpropertypoints:

{


"updates":[

{

"source":{...},

"timestamp":"2014-08-15T19:02:31.507Z",

"values":[

{

FullandDeltaModels

11

"path":"",

"value":{

"name":"WRANGO"

}

}

]

}

]

}

DataQualityDatatransmittedinSignalKformatisassumedtobecorrectedforknownsensorinaccuraciessuchaswindangleoffsetduetomisalignmentofamastheadunitonthemast,butthereisnoguaranteethatdataisaccurate,orwithincertainbounds.Differentsourceswillhavedifferentdataqualityandnormalvigilanceisalwaysrequired.

MissingorInvalidDataAsensororgateway/servermaywanttosendamessageindicatingknowninvaliddataorthefactthatthesensorisfunctioningbutcannotprovidedata,forexamplewhenadepthsensorhasnobottomfix.InthiscasethevaluemustbeJSONnullinthedeltamessageandtheservermustreturnthevalueasaJSONnullintheRESTAPI.

MessageIntegrityManymessagingsystemsspecifychecksumsorotherformsofmessageintegritychecking.SignalKassumesareliabletransportwillguaranteeavalidmessage.ThisistrueofTCP/IPandsomeothertransportsbutnotalwaysthecase.Forothertransports(e.g.RS-232serial)aspecificextendeddataformatwillapply,whichissuitedtothattransport.Henceatthemessagelevelnochecksumorothertestsneedtobemade.

Encoding/DecodingTheJSONmessageformatissupportedacrossmostprogrammingenvironmentsandcanbehandledwithanyconvenientlibrary.

Onmicro-controllerswithlimitedRAMitmaybenecessarytoreadandwriteSignalKdatausingastreamingprocessratherthanreadingtheentiremessageintoRAMbeforeprocessing.ThereisanimplementationofSignalKJSONstreamingonanArduinoMega(4KRAM)intherelatedFreeboardproject.

FullandDeltaModels

12

https://github.com/rob42/FreeboardMega/tree/signal_k_dev/lib/SignalK

MultipleValuesforaKeyTherearetwousecasesformultiplevaluesforasingledatapoint

Multipleinstancesofacommondevice-e.g.twoenginesormultiplebatteries.Multipledevicesprovidingduplicatedata-multiplevaluesforthesameSignalKkeyfromdifferentsensors.Thisisfairlycommonasmostboatshavemultiplesensorscapableofgeneratingthesamedata(butnotnecessarilythesamevalue).Forexample,courseoverground(COG)maycomefrombothacompassandGPSoraboatmaybeequippedwithmultipledepthsounders.

MultipleInstancesofaCommonDevice

SomepartsoftheSignalKschemaaredeviceoriented.

Forexample,manyboatshavemultiplebatteries.Howevereachbatteryhasmultiple,commonquantitieslikevoltage,currentandtemperature.Inthiscase,itmakesmoresenseforthesevaluestobeorganizedbyinstance.Therefore,intheSignalKmodel,eachbatterybankisit’sowninstance:forexampleelectrical.batteries.starterandelectrical.batteries.house.Thenbeneaththatprefixtherearethevariouspropertiesforeachbattery.

ThisorganisationallowsauserinterfacetoorganisetheindividualreadingsinmeaningfulgroupsandallowsconsumerstoqueryallthevaluesrelatedtothatpieceofequipmentviatheRESTAPI.Furthermore,thisstructuremaintainstheprimaryrequirementthatagivendatavaluehaveafixedanduniqueURI,butgivesflexibilityinthestructureandcomplexitiesofdata.

Thesamedevicecentricorganisationisusedwithinthepropulsionsubschema,tosupportthecommonusecaseoftwoenginesviapropulsion.portandpropulsion.starboard.

Thevaluesstarter,house,portandstarboardareexamplesandnotspecifiedintheschema.YouarefreetouseapplicationspecificvalueswithintheregexpspecifiedintheJSONschema.

MultipleDevicesProvidingDuplicateData

Itisquitepossibleforakeyvaluetocomefrommorethanonedevice.ManymoderndeviceshaveabuiltinGPSreceiverandasaresultonanygivenboattheremaybeseveralsourcesofposition,speedoverground,andheading.Multipledepthsoundersarealsocommon,ofteninstalledtoportandstarboardonmonohullsailboatsorineachhullofacatamaran.

Giventhatthevalidityofthesevarioussourcesofdatamaychangeinacontext-specificway,SignalKprovidesamechanismforthesevaluestobegroupedtogethersothattheconsumerofthedatamaychoosewhichvalue(orvalues)todisplay .

Whendealingwithmultiplesourcesofdata,itbecomesimportanttoknowwherethedataiscomingfrom.SignalKprovidesamechanismforthatintheformofthesourcestoplevelobjectandreferencesintothatobjectviathe$sourceproperty.Seesourcesfordetailedinformationonthestructureofthesourcesobjectandhowitisreferencedbythe$sourceproperty.

ThefirstsourceofaparticulardatapointbecomesthedefaultsourceforthatdataandanormalSignalKobjectiscreated.

{

"self":"urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d",

"version":"0.9.0",

"vessels":{

"urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d":{

"uuid":"urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d",

"navigation":{

"courseOverGroundTrue":{

"value":3.61562407843144,


1

MultipleValues

13

"timestamp":"2017-04-03T06:14:04.451Z"

}

}

}

}

}

Ithascomefromdevicesources.ttyUSB0.GP,wherefurtherdetailscanbefound.

Ifanothervaluewithdifferentsourcearrives,theSignalKserverwilladdthevaluesattributewithvaluesfromboththefirstandsecondsources.Theinitialsource‘sdatawillcontinuetopopulatethevaluepropertyinthekey.

{

"self":"urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d",

"version":"0.9.0",

"vessels":{


"uuid":"urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d",

"navigation":{

"courseOverGroundTrue":{

"value":3.615624078431440,


"timestamp":"2017-04-03T06:14:04.451Z",

"values":{

"ttyUSB0.GP.RMC":{

"value":3.615624078431440,

"timestamp":"2017-04-03T06:14:04.451Z"

},

"n2k.ikommunicate.128267":{

"value":3.615624078431453,

"timestamp":"2017-04-03T06:14:04.451Z"

}

}

}

}

}

},

"sources":{

"ttyUSB0":{

"GP":{

"sentences":{

"RMC":"2017-04-03T06:14:04.451Z"

}

}

},

"ikommunicate":{

"2":{

"n2k":{

"src":"2",

"pgns":{

"128267":"2017-04-03T06:14:05.221Z"

}

}

}

}

}

}

MultipleValuesinDeltaMessages

Whenaclientsubscribestonavigation.courseOverGroundTrue,theyreceiveallthevaluesheld.Theupdatemessagedoesnotincludethevaluespath,thecaseabovelookslike:

{

MultipleValues

14

"context":"vessels.urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d",

"updates":[

{

"source":{

"label":"GPS-1",

"type":"NMEA0183",

"talker":"GP",

"sentence":"RMC"

},

"timestamp":"2017-04-03T06:14:04.451Z",

"values":[

{


"value":3.615624078431440

}

]

},

{

"source":{

"label":"actisense",

"type":"NMEA2000",

"src":"115",

"pgn":128267

},

"timestamp":"2017-04-03T06:14:04.451Z",

"values":[

{


"value":3.615624078431453

}

]

}

]

}

Individualupdatescanbedistinguishedbytheirsource.

Ifaclientwantsonlythevaluesofaspecificsourceitshouldsubscribetoapaththatincludesthefullpathundervaluesincludingthesourcereferencekeyofthesource.Thesourcereferenceshouldbeenclosedinsquarebrackets:navigation.courseOverGroundTrue.values[n2k./dev/ikommunicate.128267].TheclientcanretrievetherelevantdataviaRESTAPI.

Note:Theexactformatoftheupdatemessageisaffectedbythesubscriptionpolicy.Apolicyofinstantwillresultinchangesbeingsentimmediately,sotypicallyoneiteminvaluesperupdate.Apolicyoffixedwillresultinperiodicupdateswhichmaycontainmanyitemsinvalues.

Theupdateallowsgroupingvaluesbysource.

[1]Specifyingpreferredsourcesisstillanunder-developmentenhancementtotheNodeserver.

MultipleValues

15

MetadataAkeypartofSignalKistheabilityfordataconsumerssuchasappsorMFDstoautomaticallyconfigurethemselvesbasedonsettingsretrievedfromtheserver.ThemetadatacomponentofSignalKfacilitatesthisthroughanoptionalmetaobjectattachedtoeachkeyintheSignalKdatamodel.

Rationale

Inanenvironmentwherevariouscriticalpiecesofinformationaredisplayedinmultiplelocationsitbecomesquitedifficulttoensurethatallofthesedevicesusethesamescaleandreactthesamewaytochangesinthedata.Thisisespeciallytrueinanenvironmentwherethesedevicesarenottiedtotheboat.AcrewmembermaybringapersonaltabletwiththemfortheirtacticianroleduringaWednesdayeveningraceoraharborpilotmaybringalaptoponboardloadedwithlocalcharts.Ifthesedevicescanloadcriticalconfigurationdatafromacentralserverontheboat,thissavestimeandpreventscostlyorevendisastrousmistakesfromoccurringduetomisconfigureddevices.

MetadataforaDataValue

Themetaobjectexistsatthesamelevelasvalueand$sourceineachkeyintheSignalKdatamodel.

{

"displayName":"PortTachometer",

"longName":"Engine2Tachometer(x60forRPM)",

"shortName":"Revs",

"description":"RevolutionsinHZ,measuredviatheWterminalonthealternator",

"gaugeType":"analog",

"units":"Hz",

"timeout":1,

"alertMethod":["visual"],

"warnMethod":["visual"],

"alarmMethod":["sound","visual"],

"emergencyMethod":["sound","visual"],

"zones":[

{"upper":50,"state":"alarm","message":"Stoppedorveryslow"},

{"lower":50,"upper":300,"state":"normal"},

{"lower":300,"upper":350,"state":"warn","message":"Approachingmaximum"},

{"lower":350,"state":"alarm","message":"Exceedingmaximum"}

]

}

Intheexamplemetaobjectabove,adefinitionisprovidedforananalogRPMgaugefortheportengine.Itprovidesafewdifferentoptionsfortheconsumertousetodisplaythenameofthemeasurementandexplicitlycallsouttheunitofmeasure.ItalsospecifiesarecommendeddisplayformatviagaugeType.

Thetimeoutpropertytellstheconsumerhowoftenitshouldexpecttowaitbeforeanewvaluearrives–oriftheconsumerispollingfordata,howlongitshouldwaitbeforerequestinganewvalue.Thisvalueisspecifiedinseconds,soforahighspeedGPSsensoritmay0.1oreven0.05.ThealertMethod,warnMethod,alarmMethodandemergencyMethodpropertiestelltheconsumerhowitshouldrespondtoanabnormaldatacondition.Presentlythevaluesforthesepropertiesaresoundandvisualandthemethodisspecifiedasanarraycontainingoneorbothoftheseoptions.Itisuptotheconsumertodecidehowtoconveythesealerts.

Thelastpropertyinthemetaobjectisthezonesarray.Thisprovidesaseriesofhintstotheconsumerwhichcanbeusedtoproperlysetarangeonadisplaygaugeandalsocolorsectorsofthegaugetoindicatenominalordangerousoperatingconditions.Italsotellstheconsumerwhichstatethedataisinforagivenrange.Combinedwiththealertmethodproperties,allSignalK

Metadata

16

consumerscanreactthesamewaytoagivenstate.

ItisalsopossibleforaSignalKservertousethisinformationtomonitoranydatawhichhasametaobjectandraiseagenericalarmevent.SeethesectiononAlarmHandlingformore.

ImplicitMetadata

AllkeysintheSignalKspecificationmusthaveunitsandadescription.IfaclientrequeststhemetapropertyforavalidSignalKkeyviatheHTTPRESTinterface,theservermustreturntheunitsanddescription,evenifnovaluehaseverbeengeneratedforthatkey.

//GET/signalk/v1/api/vessels/self/environment/depth/belowKeel/meta

{

"units":"m",

"description":"Depthbelowkeel"

}

Seekeyswithmetadata.json

DefaultConfiguration

SignalKdoesnotprovideadefaultsetofmetadata,itisuptotheownerortheirinstallertoconfiguretheirSignalKenvironmentappropriatelyfortheirvessel.However,bycentralizingthisconfigurationtheywillonlyneedtodoitonetimeandanyfutureconsumerswillautomaticallyusethisconfiguration.

AlarmManagement

Analarmwatchissetbysettingthemeta.zonesarrayappropriately.Abackgroundprocessontheserverchecksforalarmconditionsonanyattributewithameta.zonesarray.Ifthekeysvalueiswithinazonetheserversetsanalarmkeysimilartovessels.self.notifications.[original_key_suffix],e.g.analarmsetonvessels.self.navigation.courseOverGroundTruewillbecomevessels.self.notifications.navigation.courseOverGroundTrue.

Theobjectfoundatthiskeyshouldcontainthefollowing:

{

"message":"anytext",

"state":"[normal|alert|warn|alarm|emergency]"

}

OtherBenefitsWhilenotstrictlypartoftheSignalKspecification,metadataconfigurationcouldbesharedbetweenboatsorevenprovidedbymanufacturersofproductionboatsorbycomponentsupplierssuchasengineorrefrigeratormanufacturers.Also,anydevicewhichimplementsSignalKshouldprovideabaselinemetadataconfiguration.Asthisstandardbecomesmorewidespread,lessindividualconfigurationwillneedtobeperformed.

Metadata

17

https://github.com/SignalK/specification/blob/1.0.4/keyswithmetadata.json

Metadata

18

SignalKDataSourcesSignalKprovidesamethodtoidentifythespecificdeviceand—ifavailable—theNMEAsentenceorPGNwhichgeneratedaparticularvalue.Thisishandledintwoways.ThefirstiswithapointertoadeviceinthesourcessectionoftheSignalKdatamodel.WhenviewingafullSignalKdatamodel,thisisthemethodyouwillsee.EverySignalKdataobjectwillhavea$sourceproperty(notethedollarsignsigilwhichindicatesthevalueisapointer)whichcontainsadotseparatedpathtoanobjectrelativetothetop-levelsourcessection.WhenreceivingSignalKdataviadeltas,youmayalsoseesourcesreferencedthisway.However,allcurrentimplementationsofSignalKprovidesourcedatadirectlyembeddedinthedeltamessage.Thisisdoneusingthesourcepropertyofthedeltamessage.

PointerMethod

Anexampleofthepointermethodisshownbelow.

{

"version":"1.0.0",

"self":"vessels.urn:mrn:signalk:uuid:705f5f1a-efaf-44aa-9cb8-a0fd6305567c",

"vessels":{


"uuid":"urn:mrn:signalk:uuid:705f5f1a-efaf-44aa-9cb8-a0fd6305567c",

"navigation":{

"speedOverGround":{

"value":4.32693662,


"sentence":"RMC",

"timestamp":"2017-05-16T05:15:50.007Z"

}

}

}

},

"sources":{

"ttyUSB0":{

"label":"ttyUSB0",

"type":"NMEA0183",

"GP":{

"talker":"GP",

"sentences":{

"RMC":"2017-04-03T06:14:04.451Z"

}

}

}

}

}

ThisisafullSignalKmodelwithasingledatasourceandasingledataobject.Thenavigation.speedOverGroundobjectreferencesthettyUSB0.GPdeviceviathevalueofthe$sourceproperty.Inadditionto$source,thesentencepropertyisalsoincludedwhichidentifiesthespecificNMEA0183sentencerecievedfromthedatasourcewhichwasconvertedtoSignalK.

WithinthesourcessectiondevicesareconventionallyorganizedbythephysicalconnectiontotheSignalKdeviceandanidentifierforthespecificsourcedevice.Inthecaseabove,thefirstlevelofthehierarchyistheUNIXdeviceidentifierforaUSBserialportandthesecondlevelistheNMEA0183talkerIDofthepaddlewheelsensor.

DirectInclusionMethod

Thismethodisonlyimplementedindeltamessages.Anexampledeltawithaninlinesourceisshownbelow.

Sources

19

{

"updates":[

{

"source":{

"label":"ttyUSB0",

"type":"NMEA2000",

"pgn":127251,

"src":"204"

},

"timestamp":"2017-04-15T20:38:26.709Z",

"values":[

{

"path":"navigation.rateOfTurn",

"value":-0.000412469

}

]

}

],

"context":"vessels.urn:mrn:imo:mmsi:338184312"

}

ThisparticularsourceisanNMEA2000devicesoithasthepgnandsrcproperties,butNMEA0183orothersourcetypesaresimilarlysupported.AnNMEA0183sourcewouldbestructuredlikethis:

{

"label":"NMEA0183-0",

"type":"NMEA0183",

"sentence":"RMC",

"talker":"GP"

}

Afinalexampleusinganon-NMEAsource,inthiscaseanI²Csensor.

{

"type":"I2C",

"label":"I²CBus#0",

"src":"14"

}

Here,srcistheaddressofthedeviceontheI²Cbus.

SourcesGroup

ASignalKdevicecapableofgeneratingafulldatamodelwillhaveatoplevel(i.e.atthesamelevelasvessels,versionandself)groupcalledsources.ThisgroupprovidesdetailedinformationabouteachnetworkbusconnectedtotheSignalKgatewayorserver.Sourcesareorganizedhierarchically,followingabus-source-typestructure.

Anexampleofmultiplesourcesisshownbelow.

{

"vhf":{

"label":"AISReceiver",

"type":"VHF",

"112334556":{

"ais":{

"aisType":15

}

},

"394299113":{

"ais":{

Sources

20

"aisType":15

}

}

},

"ttyUSB0":{

"label":"NMEA0183",

"type":"NMEA0183",

"II":{

"talker":"II",

"sentences":{

"VHW":"2018-04-16T01:34:03.881Z"

}

}

},

"ttyUSB1":{

"label":"NMEA2000",

"type":"NMEA2000",

"3":{

"1":{},

"2":{},

"n2k":{

"src":"3",

"pgns":{

"126992":"2017-04-15T18:44:59.006Z"

}

}

}

}

}

YoumaynoticetwooddlinesintheNMEA2000source"3":"1":{}and"2":{}'.TheseareplaceholdersforNMEA2000"instance"values.TheseareheretoprovideavalidschemaforcertainNMEA2000PGNsrelatingtotemperature.BecausetemperaturepathsinthecurrentversioofSignalKdonothavetheinstanceinline,consumersmustlookattheinstancepartofthe$sourceorsourcepropertytodeterminewhichspecificsensorprovidedthedata.

Sources

21

URLsandPortsWhileSignalKisatransport-agnisticprotocol,therearecertainconventionsthathavebeenestablishedforuseontheWebandbyclientsandserversusingHTTPandWebSockets.

Ports

TheSignalKHTTPandWebSocketservicesSHOULDbefoundontheusualHTTP/Sports(80or443).TheservicesSHOULDbefoundonthesameport,butmaybeconfiguredforindependentportsandMAYbeconfiguredforportsotherthanHTTP/S.

ASignalKserverMAYofferSignalKoverTCPorUDP,theseservicesSHOULDbeonport8375 .

IfanalternateportisneededitSHOULDbeanarbitraryhighportintherange49152–65535 .

URLPrefixTheSignalKapplicationsstartfromthe/signalkroot.Thisprovidessomeprotectionagainstnamecollisionswithotherapplicationsonthesameserver.ThereforetheSignalKentrypointwillalwaysbefoundbyloadinghttp(s)://«host»:«port»/signalk.

[1]ThishasnotbeenregisteredwithIANAyet.ItistheASCIIdecimalcodeforSK.[2]ThisistheprivateusesectionofIPportsspecifiedasreservedbyIANA.

1

2

URLsandPorts

22

RESTAPISignalKproducersMAYimplementanHTTPAPIwhichconsumerscanusetoself-configure,pollforSignalKdataormakeconfigurationchanges.Asspecifiedintheprevioussection,allURLsforinteractingwithSignalKarerootedat/signalk.

GET/signalk

MakingaGETrequestto/signalkreturnsaJSONobjectwhichspecifiestheavailableSignalKendpointsandsomeinformationabouttheserver.Alsoseeversioningfordetailsaboutversionstrings.

{

"endpoints":{

"v1":{

"version":"1.0.0-alpha1",

"signalk-http":"http://localhost:3000/signalk/v1/api/",

"signalk-ws":"ws://localhost:3000/signalk/v1/stream"

},

"v3":{

"version":"3.0.0",

"signalk-http":"http://localhost/signalk/v3/api/",

"signalk-ws":"ws://localhost/signalk/v3/stream",

"signalk-tcp":"tcp://localhost:8367"

}

},

"server":{

"id":"signalk-server-node",

"version":"0.1.33"

}

}

Thisresponseisdefinedbythediscovery.jsonschema.Inthisexample,theserversupportstwoversionsofthespecification:1.alpha1and3.0.Foreachversion,theserverindicateswhichtransportprotocolsitsupportsandtheURLthatcanbeusedtoaccessthatprotocol‘sendpoint.Clientsshoulduseoneofthesepublishedendpointsbasedontheprotocolversiontheywishtouse.

TheservermustonlyreturnvalidURLsandshoulduseIANAstandardprotocolnamessuchashttp.However,aservermaysupportunofficialprotocolsandmayreturnadditionalprotocolnames;forexample,theresponseaboveindicatestheserversupportsasignalk-tcpstreamoverTCPatonport8367.

AservermayreturnrelativeURIsthattheclientmustresolveagainstthebaseoftheoriginalrequest.

Aservermayreturninformationaboutitselfintheserverproperty.Theidandversionschemeisnotdefinedaspartofthespecificationandthereisnoregistryforidvalues.

/signalk/«version»/api/Notethetrailingslashinthepath

ThebaseURLMUSTprovideaSignalKdocumentthatisvalidaccordingtothefullSignalKschemaspecification.ThecontentsSHOULDbeallthecurrentvaluesofthedataitemstheserverknowsintheSignalKfullformatasspecifiedinFullandDeltaModels.

/signalk/«version»/api/*

RESTAPI

23

TheSignalKdataSHOULDbeavailableviatheRESTAPI.Forexample,GET/signalk/v1/api/vesselsshouldreturnallofthedataunderthevesselscontainerinJSONformat.Likewise,GET/signalk/v1/api/vessels/urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021dshouldreturndataforonespecificvessel.Inotherwords,thefullSignalKdatamodelSHOULDbetraversablebyanyclientmakingGETrequeststoanarbitrarydepth.

RESTAPI

24

StreamingWebSocketAPI:/signalk/«version»/streamInitiatesaWebSocketconnectionthatwillstartstreamingtheserver’supdatesasSignalKdeltamessages.Youcanspecifythecontentsofthestreabyusingthesubscribequeryparameter.

ws://hostname/signalk/«version»/stream?subscribe=selfws://hostname/signalk/«version»/stream?subscribe=allws://hostname/signalk/«version»/stream?subscribe=none

Withnoqueryparameterthedefaultisself,whichwillstreamthedatarelatedtotheselfobject.allwillstreamalltheupdatestheserverseesandnonewillstreamonlytheheartbeat,untiltheclientissuessubscribemessagesintheWebSocketstream.

IfaserverdoesnotsupportsomestreamingoptionslistedinhereitmustrespondwithHTTPstatuscode501NotImplemented.

SeeSubscriptionProtocolformoredetails.

ConnectionHelloUponconnectiona'hello'messageissentasfollows:

{

"version":"1.1.2",

"timestamp":"2015-04-13T01:13:50.524Z",

"self":"123456789"

}

StreamingWebSocketAPI

25


Introduction

BydefaultaSignalKserverwillprovideanewWebSocketclientwithadeltastreamofthevessels.selfrecord,asupdatesarereceivedfromsources.E.g./signalk/v1/streamwillprovidethefollowingdeltastream,everytimethelogvaluechanges.

{


"updates":[

{

"source":{

"label":"N2000-01",

"type":"NMEA2000",

"src":"115",

"pgn":128275

},

"values":[

{

"path":"navigation.trip.log",

"value":43374

},

{

"path":"navigation.log",

"value":17404540

}

]

}

]

}

BelowwerefertoWebSockets,butthesameprocessworksinthesamewayoveranytransport.E.g.forarawTCPconnectiontheconnectioncausestheabovemessagetobesent,andsendingthesubscribemessageswillhavethesameeffectasdescribedhere.

Thiscanbealotofmessages,manyyoumaynotneed,especiallyifyourboathasmanysensors,orotherdatasources.Oftenyouwillwanttosubscribetoamuchsmallerrangeofdata.Especiallyforsinglevaluedisplays,itdoesnotmakesensetogettheentiredatastreamwhenonlyasinglevalueiswanted.

Firstyouwillwanttounsubscribefromthecurrentdefault(oryoumayhavealreadyconnectedwithws://hostname/signalk/v1/stream?subscribe=none).TounsubscribeallcreateanunsubscribemessagewithwildcardsandsendthemessageovertheWebSocketconnection:

{

"context":"*",

"unsubscribe":[

{"path":"*"}

]

}

Tosubscribetotherequiredcriteriasendasuitablesubscribemessage:

{

"context":"vessels.self",

"subscribe":[

{

"path":"navigation.speedThroughWater",


26

"period":1000,

"format":"delta",

"policy":"ideal",

"minPeriod":200

},

{

"path":"navigation.logTrip",

"period":10000

}

]

}

path=[path.to.key]isappendedtothecontexttospecifysubsetsofthecontext.Thepathvaluecanusethewildcard*.Awildcardinthemiddleofapath(propulsion/*/oilTemperature)allowsanyvalueforthatpartandawildcardattheend(propulsion/port/*)matchesallpathsbeginningwiththespecifiedprefix.

Thefollowingareoptional,includedaboveonlyforexampleasitusesdefaultsanyway:

period=[millisecs]becomesthetransmissionrate,e.g.everyperiod/1000seconds.Default:1000format=[delta|full]specifiesdeltaorfullformat.Default:deltapolicy=[instant|ideal|fixed].Default:ideal

instantmeanssendallchangesasfastastheyarereceived,butnofasterthanminPeriod.Withthispolicytheclienthasanimmediatecopyofthecurrentstateoftheserver.idealmeansuseinstantpolicy,butifnochangesarereceivedbeforeperiod,thenresendthelastknownvalues.fixedmeanssimplysendthelastknownvalueseveryperiod.

minPeriod=[millisecs]becomesthefastestmessagetransmissionrateallowed,e.g.everyminPeriod/1000seconds.Thisisonlyrelevantforpolicy='instant'toavoidswampingtheclientornetwork.

Youcansubscribetomultipledatakeysmultipletimes,frommultipleappsordevices.Eachappordevicesimplysubscribestothedataitrequires,andtheserverand/orclientimplementationmaycombinesubscriptionstoavoidduplicationasitprefersonaperconnectionbasis.Atthesametimeitisgoodpracticetoopentheminimumconnectionsnecessary,forinstanceoneWebSocketconnectionsharedbetweenaninstrumentpanelwithmanygauges,ratherthenoneWebSocketconnectionpergauge.

MultiplevaluehandlinginsubscriptionsAsubscriptiontoakeyisforalltheupdatestothatkey.Iftherearemultiplesourcesgeneratingdataforthatkeytheclientwillgetalltheirupdates.

Ifaclientwantsonlythevaluesofasinglesourceitshouldsubscribetoapaththatincludesthefullpathundervaluesincludingthesourcereferencekeyofthesource.Thesourcereferenceshouldbeenclosedinsquarebrackets:navigation.speedThroughWater.values[n2kFromFile.43].TheclientcanretrievetherelevantdataviaRESTAPI.SeeMultipleValuesformoreinformation.

Singleuse,orintermittentdata

Whendataisrequiredonceonly,oruponrequestthesubscribe/unsubscribemethodshouldnotbeused.IftheclientishttpcapabletheRESTAPIisagoodchoice,oruseget/list/putmessagesoverWebSocketsorTCP.

UseCasesandProposedSolutions

Localboatindividualinstruments


27

Agauge-typedisplayforjustoneorafewdataitemsforthe'self'vesselshouldbeabletospecifythatitonlywantsthoseitemsfortheselfvessel.

ThiscanbeachievedbyadefaultWebSocketconnection/signalk/v1/stream?subcribe=none,thensendingaJSONmessage:

{

"context":"vessels.self",

"subscribe":[

{

"path":"environment.depth.belowTransducer"

},

{"path":"navigation.speedThroughWater"}

]

}

TheJSONformatisalsoviableoverasimpleTCPorserialtransport,andisthereforesupportedastheprimarysubscriptionmethod.

Mapdisplaywithallknownvesselpositions&directions,servedover3Gcellularconnection

{

"context":"vessels.*",

"subscribe":[

{

"path":"navigation.position",

"period":120000,

"policy":"fixed"

},

{

"path":"navigation.courseOverGround",

"period":120000,

"policy":"fixed"

}

]

}

TheresultisadeltamessageoftheSignalKdatawithjustpositionandcourseOverGroundbranchesforallknownvessels,sentevery2minutes(120seconds)evenifnodatahasbeenupdated.

Positionofacertainvessel,immediatelyitchanges,butonceperminuteatmost

{

"context":"vessels.230029970",

"subscribe":[

{

"path":"navigation.position",

"minPeriod":60000,

"policy":"instant"

}

]

}

Theresultwillbedeltapositionmessagesforvessel230029970,broadcastwheneveritchanges,butwithminimumintervalof60seconds.Messagesaredelayedtomeettheminimumintervalwithnewermessagesoverridingthepreviousmessageinthebuffer.


28


29

DiscoveryandConnectionEstablishment

ServiceDiscovery

ASignalKserverSHOULDadvertiseitsservicesusingDNSServiceDiscovery(DNS-SD)viaMulticastDNS(mDNS);alsoknownasBonjour.TheserverMUSTprovideDNSService(SRV)RecordsandText(TXT)RecordsdescribingtheSignalKinterfacesitprovides.Theseserviceidentifiersare:

_http._tcpfortheserver'swebinterface_signalk-http._tcpfortheSignalKRESTAPI_signalk-ws._tcpfortheWebSocketdatastream

IfaserverisprovidingSignalKviasecureversionsofHTTPorWebSocketsthentheyMUSTbeabletoprovidearedirectiontothesecureversionsoftheseprotocols.

IfaSignalKserverisusingDNS-SD,itMUSTprovidethefollowingparameters(key/valuepairs)intheTXTrecordportionoftheDNS-SDadvertisement:

txtversisaUS-ASCIIdecimalnumberidentifyingtheversionoftheDNS-SDrecord.Currently,thisMUSThaveavalueof1rolesspecifieswhichrolestheserveriscapableofproviding.SeeRolesbelowfordetails

TheserverMAYprovidethefollowingvalues:

selfistheuniqueidentifierofthevesselusingtheURNformatspecifiedfortheuuidfieldintheSignalKschema.ItmayalsousetheURNformatspecifiedforthemmsifieldintheSignalKschemaifitexists.swnameisthenameoftheSignalKserversoftware,e.g.signalk-server-nodeswversistheversionoftheSignalKserversoftware

AnexampleDNS-SDrecordsetisshownbelow.

Servicedataforservice'signalk-http'oftype'_signalk-http._tcp'indomain'local'on4.0:

Host10-1-1-40.local(10.1.1.40),

port80,

TXTdata:[

'txtvers=1',

'roles=master,main',

'self=urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d',

'swname=signalk-server',

'swvers=0.1.23'

]

Servicedataforservice'signalk-ws'oftype'_signalk-ws._tcp'indomain'local'on4.0:

Host10-1-1-40.local(10.1.1.40),

port3000,

TXTdata:[

'txtvers=1',

'roles=master,main',

'self=urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d',

'swname=signalk-server',

'swvers=0.1.23'

]

TheserecordsareadvertisingaSignalKserverwiththeHTTPRESTAPIonport80andtheWebSocketdatastreamonport

1. TheserveridentifiesashavingthemasterandmainrolesandprovidesaselfidentifierasaUUID.


30

https://tools.ietf.org/html/rfc6763

https://en.wikipedia.org/wiki/SRV_record

https://en.wikipedia.org/wiki/TXT_record

Roles

Thefourpossiblevaluesforrolesaremaster,slave,main,andaux.Thesearedefinedbelow.

Master

masteristhecanonicalsourceforidentityandconfigurationinformationfortheentirevessel.

Ifthereisonlyonemasteronthevessel,thenitshouldalsoprovidethemainrole.Thecombinationofmasterandmaininformsaclientthatthisserverisactivelyprovidingidentifyinginformation.

MainandAux

Iftherearemorethanonemastersonthevessel,EXACTLYONEservershouldadvertisebothmasterandmain.Allothermastersshouldadvertisemasterandaux.Clientsshouldonlyusethemasterauxserversforidentifyinginformationifthemastermainisnotavailable.

AnyserveridentifyingasmasterMUSTbeabletoprovideataminimumtheuniqueidentifier(self)forthevessel.

Slave

Anyserverprovidingtheslaveroleshouldretrieveidentityandconfigurationinformationfromthemasterserver.SlaveserversMAYprovideconfigurationandidentityinformationforthemselves,butthisidentityMUSTNOTbeconsideredvalidfortheentirevesssel.

MainandAux

Theuseofmainandauxhavenotbeendefinedfortheslaveroleatthistime.

ConnectionEstablishment

UsingtheinformationaboveawebclientorHTTPcapabledevicecandiscoverandconnecttoaSignalKserverusingthefollowingprocess:

QueryforSignalKservicesusingmDNSConnecttothehostandportadvertisedas'signalk-http'viaHTTP(e.g.http://10.1.1.40:80)PerthePorts,UrlsandVersioningsection,makeaGETrequestfor/signalktoretrieveaJSONobjectcontaininganendpointsJSONobjectMakefurtherRESTcallsformorespecificdata,oropenawebsocketconnectiontostartstreamingupdates.


31


32


33

Alarm,Alert,andNotificationHandlingHandlingalarms,alerts,andnotificationsinSignalKisamulti-stageprocess.Alarms,alertsandnotificationsareallhandledthesameway,andareallreferredtoasalarmsbelow.

Weneedaflexiblemodeltodefinealarmconditions,andastandardwaytoannounceandrecordthem.

AlarmProcess

DefinealarmstatesaszonesinthemetaobjectattachedtoanySignalKvalue.See[[MetadataforDataValues]]Ifthevalueiswithinanalarmzoneraisethedefinedalarm.Ifthevaluegoesoutofthezone,removethealarmbysettingitsvaluetonullAlarmsareraisedbyplacinganalarmobjectinthevessels.self.notificationstree

Expectedimplementationbehaviour

Theserver(ordevice)shouldmonitorthecurrentvalueandcompareittothedefinedzones.Ifavalueentersanalarmzone,thenakeyiswrittentovessels.self.notifications..Ifavalueleavesanalarmzone,thenthekeyisremovedfromvessels.self.notifications..Alarmsraisedaremonitoredbyanalarmprocessontheserver,whichtakesappropriateaction,soundingalarms,ordisplayingmessages.Clientsinterestedinalarmscansubcribetothevessels.self.notifications...treeintheusualwayandbeinformedofalarmsinthesamewayasnormalsignalkkeys.Whenanalarmsisremoved,adeltashouldbesenttosubscriberswiththepathandanullvalue.

Example

egIfweexceedouranchoralarmradius:vessels.self.navigation.anchor.currentRadiusentersvessels.self.navigation.anchor.currentRadius.meta.zones[[50,500,"alarm","Dragginganchor!"]],

Thealarmis:vessels.self.notifications.navigation.anchor.currentRadius

Thealarmobjectis

{

"value":{

"method":["sound"],

"state":"alarm",

"message":"Dragginganchor!"

},

"timestamp":"...",

"$source":"..."

}

Theserveralarmmanagerwillseethisnewentryandturnonthealarm.Usingamanagerprocessallowsflexibilityinsituationswheremultiplealarmsaretriggeredandyourvesselisamassofflashingandbeeping.egAsingle'Pause'buttoncangiveyou5-10minutestotakeaction,stoppingannoyingnoise,andremovingpopupmessagesfromscreens.

Sincethevessels.self.notificationstreemirrorstheotherdatainthesignalkmodel,wecanselectivelywatchorreacttospecificbranchesorkeys.Whendisplayingmultiplealarmsascreencanalsosortandfilterthem.

Notifications

34

OtherAlarms

Abovewehavediscussedmonitoringexistingvaluesandraisingalarms.Thereareotheralarmsthatmustbeconsidered,egMOB,fire,sinkingetc,andmiscalerts"GPSsignallost".etc.

Thevessels.[uuid].notificationstreeisthesameasanyotherSignalkbranch.Keyscanbeaddedandremovedasrequiredintheusualway.Sincethebranchisbeingmonitoredweonlyneedtoaddakeyofanysorttocreateasuitablealarm.

Inthecaseofanemergency,createauniquekey:Thealarmis:vessels.[uuid].notifications.[alarm.key]

Thealarmobjectis

{

"value":{

"method":["visual","sound"],

"state":"emergency",

"message":"ManOverboard!"

},

...

}

Alarmobjectsthathavebeenraisedthiswaymustbeclearedmanually,orbytheprocessthatcreatedthem.Youcanuseanysuitablepath,keepinginmindthecontextofthealarm.

egInthecaseofanalert,createauniquekeybygeneratingapath:Thealarmis:vessels.[uuid].notifications.navigation.gnss

Thealarmobjectis

{

"value":{

"method":["visual"],

"state":"alert",

"message":"GPSsignallost!"

},

...

}

WellKnownNames

Somealarmsareespeciallyimportant,egMOB.Thisisalistofkeysforspecialalarms.

..notifications.mob.*

..notifications.fire.*

..notifications.sinking.*

..notifications.flooding.*

..notifications.collision.*

..notifications.grounding.*

..notifications.listing.*

..notifications.adrift.*

..notifications.piracy.*

..notifications.abandon.*

AnexampletosendanMOBalarmfromanN2Ksource,thegatewaywouldconvertandsendsomethinglike:

{


"updates":[

{

Notifications

35

"source":{...},

"timestamp":"2017-08-15T16:00:05.200Z",

"values":[

{

"path":"notifications.mob",

"value":{

"message":"MOB",


"method":["visual","sound"]

}

}

]

}

]

}

Theresultingfullsignalktreewouldbe:

{

"vessels":{


"uuid":"...",

"notifications":{

"mob":{

"value":{

"method":["visual","sound"],


"message":"ManOverboard!"

},

"timestamp":"2017-04-10T08:33:53Z",

"$source":"..."

}

}

}

},

...

}

Toclearthealarmcondition,send:

{


"updates":[

{

"source":{...},

"timestamp":"2017-08-15T16:00:05.538Z",

"values":[

{

"path":"notifications.mob",

"value":null

}

]

}

]

}

Multiplecasesofthesamealarm

Shouldmultiplecasesofthesamealarmoccur(egagpslosessignal,thenasecondgpslosessignal)thealarmsarehandledthesameasanyothermultiplevaluesinsignalk.Howeveralarmswilltendtobere-issuedwhenevertheunderlyingdatachanges.

Notifications

36

Theserversalarmmonitoringprocessesareexpectedtobesmartenoughtoknowthattheanchoralarmistriggered,anditsnotnecessarytoraiseasecondcopyofthesamealarm,afterallthereisonlyoneboatdragging!

Thismaybehandleddifferentlyfornotifications.Itmaybeusefultoknowthatyourgps'sareallfailingintermittently,orthat.Hencethehandlingofmultiplecopiesofalarmsisanimplementationissue,andmayvary.

Thekeyshouldbeunique

Ifwehaveanalarmvessels.self.notifications.navigation.anchor.currentRadiusandweattempttowriteanotherhigherinthesametreeatvessels.self.notificationsitmustnotreplaceorremovetheexistingalarm.Sincethemeta.zonesstructureisonlyvalidonsignalkleafvaluesthisoccursnaturallyinmostcircumstances.Butitispossibletosetanalarmvaluearbitrarily(egMOB)andcareshouldbetakeninimplementationsthatkeysdonotoverwriteexistingpaths.

Notifications

37

Thisisaquickstartforany-onethatwouldliketocontribute.Itsroughlyfromtechnicallyunskilledtoskilled,toptobottom.Dontbeafraidtoaskforhelp.EachtaskwillprobablystartwithanewthreadformoredetailsontheGooglegroups(https://groups.google.com/forum/#!forum/signalk).Bepatient,civil,andpersistent:-)

Completelyunskilledatboatelectronics:

Joinhttps://groups.google.com/forum/#!forum/signalk-astheuserbasegrows,sodoesawareness.Tellothers,spreadthewordFlyaSignalKflagfromyourboatIfyouhavespecialskills(egmotors,batteries,navigation,etc)helpusextendtheSignalKprotocolbyidentifyingwhatweneedtocover.AskmanufacturersaboutSignalKsupportAskquestionsaboutwhatyoudontunderstand,andcollatetheanswersforustoputonthewebsite.

Candoowninstalls,handyman,butnotITskilled.

TryaninstallofRaspberryPiandWIFI,documentexactlyhowyoudidit,sootherscanfollow.

Websiteordocumentationskills

Helpusmaintainthewebsite,andimprovethedocuments

Goodcomputerskills,butnotprogramming

Downloadandtrythejavaserver(https://github.com/SignalK/signalk-server-java)andnodeserver(https://github.com/SignalK/signalk-server-node)andthevariousappsandclients.Helptestandidentifyissues,helpimprovedocumentssootherscanfolloweasier.HelpwithUsermanuals!

Systemsengineer

Helpotherusers,helpwithscripts,developandmaintaininstallprocesses,managingourwebsites,etc.Examples:

CreateDebianpackagesoftheSignalKsoftwareforeasyinstallationtoRaspbian

Softwaredeveloper

Downloadandtest/fixourstuff,addimprovements,jointheteamandhelpcode,developsupportinyourownsoftware.

Microprocessors

ImproveourArduinostuff,addyourown,incorporateSignalKintoyourproducts.

HowCanIHelp?

38

https://groups.google.com/forum/#!forum/signalk

https://groups.google.com/forum/#!forum/signalk

https://github.com/SignalK/signalk-server-java

https://github.com/SignalK/signalk-server-node

/vessels

Description:Awrapperobjectforvesselobjects,eachdescribingvesselsinrange,includingthisvessel.

/vessels/<RegExp>

Title:vessel

Description:ThisregexpatternisusedforvalidationofanMMSIorSignalKUUIDidentifierforthevessel.Examples:urn:mrn:imo:mmsi:230099999urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d

/vessels/<RegExp>/url

Description:URLbasedidentityofthevessel,ifavailable.

/vessels/<RegExp>/mmsi

Description:MMSInumberofthevessel,ifavailable.

/vessels/<RegExp>/mothershipMmsi

Description:MMSInumberofthemothershipofthisvessel,ifavailable.

/vessels/<RegExp>/uuid

Description:AuniqueSignalKflavouredmaritimeresourceidentifier,assignedbytheserver.

/vessels/<RegExp>/name

Description:Thecommonnameofthevessel

/vessels/<RegExp>/flag

Description:Thecountryofshipregistration,orflagstateofthevessel

/vessels/<RegExp>/port

Description:Thehomeportofthevessel

/vessels/<RegExp>/registrations


39

Description:Thevariousregistrationsofthevessel.

/vessels/<RegExp>/registrations/imo

Description:TheIMOnumberofthevessel.

/vessels/<RegExp>/registrations/national

Description:Thenationalregistrationnumberofthevessel.

/vessels/<RegExp>/registrations/national/<RegExp>

Description:Thisregexpatternisusedforvalidatingtheidentifierfortheregistration

/vessels/<RegExp>/registrations/national/<RegExp>/country

Description:TheISO3166-2countrycode.

/vessels/<RegExp>/registrations/national/<RegExp>/registration

Description:Theregistrationcode

/vessels/<RegExp>/registrations/national/<RegExp>/description

Description:Theregistrationdescription

/vessels/<RegExp>/registrations/local

Description:Alocalorstateregistrationnumberofthevessel.

/vessels/<RegExp>/registrations/local/<RegExp>


/vessels/<RegExp>/registrations/local/<RegExp>/registration


/vessels/<RegExp>/registrations/local/<RegExp>/description


40


/vessels/<RegExp>/registrations/other

Description:Otherregistrationorpermitsforthevessel.

/vessels/<RegExp>/registrations/other/<RegExp>


/vessels/<RegExp>/registrations/other/<RegExp>/registration


/vessels/<RegExp>/registrations/other/<RegExp>/description


/vessels/<RegExp>/communication

Title:communication

Description:CommunicationdataincludingRadio,Telephone,E-Mail,etc.

/vessels/<RegExp>/communication/callsignVhf

Description:CallsignforVHFcommunication

/vessels/<RegExp>/communication/callsignHf

Description:CallsignforHFcommunication

/vessels/<RegExp>/communication/phoneNumber

Description:Phonenumberofskipper

/vessels/<RegExp>/communication/emailHf

Description:EmailaddresstobeusedforHFemail(Winmail,Airmail,Sailmail)


41

/vessels/<RegExp>/communication/email

Description:Regularemailfortheskipper

/vessels/<RegExp>/communication/satPhoneNumber

Description:Satellitephonenumberforvessel.

/vessels/<RegExp>/communication/skipperName

Description:Fullnameoftheskipperofthevessel.

/vessels/<RegExp>/communication/crewNames

Description:Arraywiththenamesofthecrew

/vessels/<RegExp>/environment

Title:environment

Description:EnvironmentaldatameasuredlocallyincludingDepth,Wind,Temp,etc.

/vessels/<RegExp>/environment/outside

Description:Environmentalconditionsoutsideofthevessel'shull

/vessels/<RegExp>/environment/outside/temperature

Units:K(Kelvin)

Description:Currentoutsideairtemperature

/vessels/<RegExp>/environment/outside/dewPointTemperature

Units:K(Kelvin)

Description:Currentoutsidedewpointtemperature

/vessels/<RegExp>/environment/outside/apparentWindChillTemperature

Units:K(Kelvin)

Description:Currentoutsideapparentwindchilltemperature


42

/vessels/<RegExp>/environment/outside/theoreticalWindChillTemperature

Units:K(Kelvin)

Description:Currentoutsidetheoreticalwindchilltemperature

/vessels/<RegExp>/environment/outside/heatIndexTemperature

Units:K(Kelvin)

Description:Currentoutsideheatindextemperature

/vessels/<RegExp>/environment/outside/pressure

Units:Pa(Pascal)

Description:Currentoutsideairambientpressure

/vessels/<RegExp>/environment/outside/humidity

Units:ratio(Ratio)

Description:Currentoutsideairrelativehumidity

/vessels/<RegExp>/environment/outside/airDensity

Units:kg/m3(undefined)

Description:Currentoutsideairdensity

/vessels/<RegExp>/environment/outside/illuminance

Units:Lux(undefined)

Description:Currentoutsideambientlightflux.

/vessels/<RegExp>/environment/inside

Description:Environmentalconditionsinsidethevessel'shull

/vessels/<RegExp>/environment/inside/temperature

Units:K(Kelvin)

Description:Currentinsideairtemperature


43

/vessels/<RegExp>/environment/inside/humidity

Units:ratio(Ratio)

Description:Currentinsideairrelativehumidity

/vessels/<RegExp>/environment/inside/engineRoom

Description:Currentengineroomairtemperature

/vessels/<RegExp>/environment/inside/engineRoom/temperature

Units:K(Kelvin)

Description:Temperature

/vessels/<RegExp>/environment/inside/engineRoom/pressure

Units:Pa(Pascal)

Description:Pressureinzone

/vessels/<RegExp>/environment/inside/engineRoom/relativeHumidity

Units:ratio(Ratio)

Description:Relativehumidityinzone

/vessels/<RegExp>/environment/inside/engineRoom/dewPoint

Units:K(Kelvin)

Description:Dewpointinzone

/vessels/<RegExp>/environment/inside/engineRoom/airDensity


Description:Airdensityinzone

/vessels/<RegExp>/environment/inside/engineRoom/illuminance


Description:Illuminanceinzone


44

/vessels/<RegExp>/environment/inside/mainCabin

Description:Currentmaincabinairtemperature

/vessels/<RegExp>/environment/inside/mainCabin/temperature

Units:K(Kelvin)


/vessels/<RegExp>/environment/inside/mainCabin/pressure

Units:Pa(Pascal)


/vessels/<RegExp>/environment/inside/mainCabin/relativeHumidity

Units:ratio(Ratio)


/vessels/<RegExp>/environment/inside/mainCabin/dewPoint

Units:K(Kelvin)


/vessels/<RegExp>/environment/inside/mainCabin/airDensity



/vessels/<RegExp>/environment/inside/mainCabin/illuminance



/vessels/<RegExp>/environment/inside/refrigerator

Description:Currentrefrigeratortemperature

/vessels/<RegExp>/environment/inside/refrigerator/temperature


45

Units:K(Kelvin)


/vessels/<RegExp>/environment/inside/refrigerator/pressure

Units:Pa(Pascal)


/vessels/<RegExp>/environment/inside/refrigerator/relativeHumidity

Units:ratio(Ratio)


/vessels/<RegExp>/environment/inside/refrigerator/dewPoint

Units:K(Kelvin)


/vessels/<RegExp>/environment/inside/refrigerator/airDensity



/vessels/<RegExp>/environment/inside/refrigerator/illuminance



/vessels/<RegExp>/environment/inside/freezer

Description:Currentfreezertemperature

/vessels/<RegExp>/environment/inside/freezer/temperature

Units:K(Kelvin)


/vessels/<RegExp>/environment/inside/freezer/pressure


46

Units:Pa(Pascal)


/vessels/<RegExp>/environment/inside/freezer/relativeHumidity

Units:ratio(Ratio)


/vessels/<RegExp>/environment/inside/freezer/dewPoint

Units:K(Kelvin)


/vessels/<RegExp>/environment/inside/freezer/airDensity



/vessels/<RegExp>/environment/inside/freezer/illuminance



/vessels/<RegExp>/environment/inside/heating

Description:Currentheatingtemperature

/vessels/<RegExp>/environment/inside/heating/temperature

Units:K(Kelvin)


/vessels/<RegExp>/environment/inside/heating/pressure

Units:Pa(Pascal)


/vessels/<RegExp>/environment/inside/heating/relativeHumidity


47

Units:ratio(Ratio)


/vessels/<RegExp>/environment/inside/heating/dewPoint

Units:K(Kelvin)


/vessels/<RegExp>/environment/inside/heating/airDensity



/vessels/<RegExp>/environment/inside/heating/illuminance



/vessels/<RegExp>/environment/water

Description:Environmentalconditionsofthewaterthatthevesselissailingin

/vessels/<RegExp>/environment/water/temperature

Units:K(Kelvin)

Description:Currentwatertemperature

/vessels/<RegExp>/environment/water/salinity

Units:ratio(Ratio)

Description:Watersalinity

/vessels/<RegExp>/environment/depth

Title:depth

Description:Depthrelateddata

/vessels/<RegExp>/environment/depth/belowKeel


48

Units:m(Meter)

Description:Depthbelowkeel

/vessels/<RegExp>/environment/depth/belowTransducer

Units:m(Meter)

Description:DepthbelowTransducer

/vessels/<RegExp>/environment/depth/belowSurface

Units:m(Meter)

Description:Depthfromsurface

/vessels/<RegExp>/environment/depth/transducerToKeel

Units:m(Meter)

Description:Depthfromthetransducertothebottomofthekeel

/vessels/<RegExp>/environment/depth/surfaceToTransducer

Units:m(Meter)

Description:Depthtransducerisbelowthewatersurface

/vessels/<RegExp>/environment/current

Title:current

Description:Directionandstrengthofcurrentaffectingthevessel

Objectvaluewithproperties

drift(m/s)setTrue(rad)setMagnetic(rad)

/vessels/<RegExp>/environment/tide

Title:tide

Description:Tidedata

/vessels/<RegExp>/environment/tide/heightHigh


49

Units:m(Meter)

Description:Nexthightideheightrelativetolowestastronomicaltide(LAT/ChartDatum)

/vessels/<RegExp>/environment/tide/heightNow

Units:m(Meter)

Description:Thecurrenttideheightrelativetolowestastronomicaltide(LAT/ChartDatum)

/vessels/<RegExp>/environment/tide/heightLow

Units:m(Meter)

Description:Thenextlowtideheightrelativetolowestastronomicaltide(LAT/ChartDatum)

/vessels/<RegExp>/environment/tide/timeLow

Units:RFC3339(UTC)(undefined)

Description:TimeofthenextlowtideinUTC

/vessels/<RegExp>/environment/tide/timeHigh


Description:TimeofnexthightideinUTC

/vessels/<RegExp>/environment/heave

Units:m(Meter)

Description:Verticalmovementofthevesselduetowaves

/vessels/<RegExp>/environment/wind

Title:wind

Description:Winddata.

/vessels/<RegExp>/environment/wind/angleApparent

Units:rad(Radian)

Description:Apparentwindangle,negativetoport


50

/vessels/<RegExp>/environment/wind/angleTrueGround

Units:rad(Radian)

Description:Truewindanglebasedonspeedoverground,negativetoport

/vessels/<RegExp>/environment/wind/angleTrueWater

Units:rad(Radian)

Description:Truewindanglebasedonspeedthroughwater,negativetoport

/vessels/<RegExp>/environment/wind/directionChangeAlarm

Units:rad(Radian)

Description:Theanglethewindneedstoshifttoraiseanalarm

/vessels/<RegExp>/environment/wind/directionTrue

Units:rad(Radian)

Description:Thewinddirectionrelativetotruenorth

/vessels/<RegExp>/environment/wind/directionMagnetic

Units:rad(Radian)

Description:Thewinddirectionrelativetomagneticnorth

/vessels/<RegExp>/environment/wind/speedTrue

Units:m/s(Meterspersecond)

Description:Windspeedoverwater(ascalculatedfromspeedApparentandvessel'sspeedthroughwater)

/vessels/<RegExp>/environment/wind/speedOverGround


Description:Windspeedoverground(ascalculatedfromspeedApparentandvessel'sspeedoverground)

/vessels/<RegExp>/environment/wind/speedApparent


Description:Apparentwindspeed


51

/vessels/<RegExp>/environment/time

Description:Atimereferenceforthevessel.Allclocksonthevesseldispayinglocaltimeshouldusethetimezoneoffsethere.IfatimezoneRegionissuppliedthetimezonemustalsobesupplied.IftimezoneRegionissuppliedthatshouldbedisplayedbyUIsinpreferencetosimplytimezone.ie12:05(Europe/London)shouldbedisplayedinpreferenceto12:05(UTC+01:00)

Fields:

millis(MillisecondssincetheUNIXepoch(1970-01-0100:00:00))timezoneOffset(OnboardtimezoneoffsetfromUTCinhoursandminutes(-)hhmm.+vemeanseastofGreenwich.ForusebyUIs)timezoneRegion(OnboardtimezoneoffsetaslistedintheIANAtimezonedatabase(tzdatabase))

/vessels/<RegExp>/environment/mode

Description:Modeofthevesselbasedonthecurrentconditions.Canbecombinedwithnavigation.statetocontrolvesselsignalsegswitchtonightmodeforinstrumentationandlights,ormakesoundsignalsforfog.

/vessels/<RegExp>/navigation

Title:navigation

Description:NavigationdataincludingPosition,CoursetonextWPinformation,etc.

/vessels/<RegExp>/navigation/lights

Title:Navigationlights

Description:Currentstateofthevesselsnavigationlights

/vessels/<RegExp>/navigation/courseOverGroundMagnetic

Units:rad(Radian)

Description:Courseoverground(magnetic)

/vessels/<RegExp>/navigation/courseOverGroundTrue

Units:rad(Radian)

Description:Courseoverground(true)

/vessels/<RegExp>/navigation/courseRhumbline

Title:Course

Description:CourseinformationcomputedwithRhumbline


52

/vessels/<RegExp>/navigation/courseRhumbline/crossTrackError

Units:m(Meter)

Description:Thedistancefromthevessel'spresentpositiontotheclosestpointonaline(track)betweenpreviousPointandnextPoint.Anegativenumberindicatesthatthevesseliscurrentlytotheleftofthisline(andthusmuststeerrighttocompensate),apositivenumbermeansthevesselistotherightoftheline(steerlefttocompensate).

/vessels/<RegExp>/navigation/courseRhumbline/bearingTrackTrue

Units:rad(Radian)

Description:ThebearingofalinebetweenpreviousPointandnextPoint,relativetotruenorth.

/vessels/<RegExp>/navigation/courseRhumbline/bearingTrackMagnetic

Units:rad(Radian)

Description:ThebearingofalinebetweenpreviousPointandnextPoint,relativetomagneticnorth.

/vessels/<RegExp>/navigation/courseRhumbline/activeRoute

Description:Datarequiredifsailingtoanactiveroute,definedinresources.

/vessels/<RegExp>/navigation/courseRhumbline/activeRoute/href

Description:Areference(URL)tothepresentlyactiveroute,inresources.

/vessels/<RegExp>/navigation/courseRhumbline/activeRoute/estimatedTimeOfArrival

Description:Theestimatedtimeofarrivalattheendofthecurrentroute

/vessels/<RegExp>/navigation/courseRhumbline/activeRoute/startTime

Description:Thetimethisroutewasactivated

/vessels/<RegExp>/navigation/courseRhumbline/nextPoint

Description:Thepointonearththevessel'spresentlynavigatingtowards

/vessels/<RegExp>/navigation/courseRhumbline/previousPoint

Description:Thepointonearththevessel'spresentlynavigatingfrom


53


typehref

/vessels/<RegExp>/navigation/courseRhumbline/previousPoint/distance

Units:m(Meter)

Description:ThedistanceinmetersbetweenpreviousPointandthevessel'spresentposition

/vessels/<RegExp>/navigation/courseRhumbline/previousPoint/position

Title:position

Description:ThepositionoflastPointintwodimensions


longitude(deg)latitude(deg)altitude(m)

/vessels/<RegExp>/navigation/courseGreatCircle

Title:Course

Description:CourseinformationcomputedwithGreatCircle

/vessels/<RegExp>/navigation/courseGreatCircle/crossTrackError

Units:m(Meter)


/vessels/<RegExp>/navigation/courseGreatCircle/bearingTrackTrue

Units:rad(Radian)


/vessels/<RegExp>/navigation/courseGreatCircle/bearingTrackMagnetic

Units:rad(Radian)



54

/vessels/<RegExp>/navigation/courseGreatCircle/activeRoute


/vessels/<RegExp>/navigation/courseGreatCircle/activeRoute/href


/vessels/<RegExp>/navigation/courseGreatCircle/activeRoute/estimatedTimeOfArrival


/vessels/<RegExp>/navigation/courseGreatCircle/activeRoute/startTime


/vessels/<RegExp>/navigation/courseGreatCircle/nextPoint


/vessels/<RegExp>/navigation/courseGreatCircle/previousPoint



typehref

/vessels/<RegExp>/navigation/courseGreatCircle/previousPoint/distance

Units:m(Meter)


/vessels/<RegExp>/navigation/courseGreatCircle/previousPoint/position

Title:position



longitude(deg)


55

latitude(deg)altitude(m)

/vessels/<RegExp>/navigation/closestApproach

Description:Calculatedvaluesforothervessels,e.g.fromAIS


distance(m)timeTo(s)

/vessels/<RegExp>/navigation/racing

Description:Specificnavigationaldatarelatedtoyachtracing.

/vessels/<RegExp>/navigation/racing/startLineStb

Title:position

Description:Positionofstarboardstartmark



/vessels/<RegExp>/navigation/racing/startLinePort

Title:position




/vessels/<RegExp>/navigation/racing/distanceStartline

Units:m(Meter)

Description:Thecurrentdistancetothestartline

/vessels/<RegExp>/navigation/racing/timeToStart

Units:s(Second)


56

Description:Timeleftbeforestart

/vessels/<RegExp>/navigation/racing/timePortDown

Units:s(Second)

Description:Timetoarriveatthestartlineonport,turningdownwind

/vessels/<RegExp>/navigation/racing/timePortUp

Units:s(Second)

Description:Timetoarriveatthestartlineonport,turningupwind

/vessels/<RegExp>/navigation/racing/timeStbdDown

Units:s(Second)

Description:Timetoarriveatthestartlineonstarboard,turningdownwind

/vessels/<RegExp>/navigation/racing/timeStbdUp

Units:s(Second)

Description:Timetoarriveatthestartlineonstarboard,turningupwind

/vessels/<RegExp>/navigation/racing/distanceLayline

Units:m(Meter)

Description:Thecurrentdistancetothelayline

/vessels/<RegExp>/navigation/magneticVariation

Units:rad(Radian)

Description:Themagneticvariation(declination)atthecurrentpositionthatmustbeaddedtothemagneticheadingtoderivethetrueheading.EasterlyvariationsarepositiveandWesterlyvariationsarenegative(inRadians).

/vessels/<RegExp>/navigation/magneticVariationAgeOfService

Units:s(Second)

Description:Secondssincethe1stJan1970thatthevariationcalculationwasmade


57

/vessels/<RegExp>/navigation/destination

Title:destination

Description:Theintendeddestinationofthistrip

/vessels/<RegExp>/navigation/destination/commonName

Description:CommonnameoftheDestination,eg'Fiji',alsousedinaismessages

/vessels/<RegExp>/navigation/destination/eta

Description:Expectedtimeofarrivalatdestinationwaypoint

/vessels/<RegExp>/navigation/destination/waypoint

Description:UUIDofdestinationwaypoint

/vessels/<RegExp>/navigation/gnss

Title:gnss

Description:Globalsatellitenavigationmetainformation

/vessels/<RegExp>/navigation/gnss/type

Description:Fixtype

/vessels/<RegExp>/navigation/gnss/methodQuality

Description:Qualityofthesatellitefix

/vessels/<RegExp>/navigation/gnss/integrity

Description:Integrityofthesatellitefix

/vessels/<RegExp>/navigation/gnss/satellites

Description:Numberofsatellites

/vessels/<RegExp>/navigation/gnss/antennaAltitude


58

Units:m(Meter)

Description:Altitudeofantenna

/vessels/<RegExp>/navigation/gnss/horizontalDilution

Description:HorizontalDilutionofPrecision

/vessels/<RegExp>/navigation/gnss/positionDilution

Description:PositionalDilutionofPrecision

/vessels/<RegExp>/navigation/gnss/geoidalSeparation

Description:DifferencebetweenWGS84earthellipsoidandmeansealevel

/vessels/<RegExp>/navigation/gnss/differentialAge

Units:s(Second)

Description:AgeofDGPSdata

/vessels/<RegExp>/navigation/gnss/differentialReference

Description:IDofDGPSbasestation

/vessels/<RegExp>/navigation/headingMagnetic

Units:rad(Radian)

Description:Currentmagneticheadingofthevessel

/vessels/<RegExp>/navigation/headingTrue

Units:rad(Radian)

Description:Thecurrenttrueheadingofthevessel

/vessels/<RegExp>/navigation/position

Title:position

Description:Thepositionofthevesselin2or3dimensions(WGS84datum)



59


/vessels/<RegExp>/navigation/attitude

Title:Attitude

Description:Vesselattitude:roll,pitchandyaw


roll(rad)pitch(rad)yaw(rad)

/vessels/<RegExp>/navigation/maneuver

Description:Specialmaneuversuchasregionalpassingarrangement.(fromais)

/vessels/<RegExp>/navigation/rateOfTurn

Units:rad/s(Radianpersecond)

Description:Rateofturn(+veischangetostarboard).IfthevalueisAISRIGHTorLEFT,setto+-0.0206radsandaddwarninginnotifications

/vessels/<RegExp>/navigation/speedOverGround


Description:Vesselspeedoverground.IfconvertingfromAIS'HIGH'value,setto102.2(Aismaxvalue)andaddwarninginnotifications

/vessels/<RegExp>/navigation/speedThroughWater


Description:Vesselspeedthroughthewater

/vessels/<RegExp>/navigation/speedThroughWaterTransverse


Description:Transversespeedthroughthewater(Leeway)


60

/vessels/<RegExp>/navigation/speedThroughWaterLongitudinal


Description:Longitudinalspeedthroughthewater

/vessels/<RegExp>/navigation/leewayAngle

Units:rad(Radian)

Description:LeewayAnglederivedfromthelongitudinalandtransversespeedsthroughthewater

/vessels/<RegExp>/navigation/log

Units:m(Meter)

Description:Totaldistancetraveled

/vessels/<RegExp>/navigation/trip

Description:Tripdata

/vessels/<RegExp>/navigation/trip/log

Units:m(Meter)

Description:Totaldistancetraveledonthistrip/sincetripreset

/vessels/<RegExp>/navigation/trip/lastReset

Description:Triplogresettime

/vessels/<RegExp>/navigation/state

Title:state

Description:Currentnavigationalstateofthevessel

/vessels/<RegExp>/navigation/anchor

Title:anchor

Description:Theanchordata,foranchorwatchetc

/vessels/<RegExp>/navigation/anchor/maxRadius


61

Units:m(Meter)

Description:Radiusofanchoralarmboundary.Thedistancefromanchortothecenteroftheboat

/vessels/<RegExp>/navigation/anchor/currentRadius

Units:m(Meter)

Description:Currentdistancetoanchor

/vessels/<RegExp>/navigation/anchor/position

Title:position

Description:Theactualanchorpositionofthevesselin3dimensions,probablyanestimateatbest



/vessels/<RegExp>/navigation/datetime

Description:TimeandDatefromtheGNSSPositioningSystem

Fields:

gnssTimeSource(SourceofGNSSDateandTime),enum:

GPSGLONASSGalileoBeidouIRNSSRadioSignalInternetLocalclock

/vessels/<RegExp>/propulsion

Title:propulsion

Description:Enginedata,eachengineidentifiedbyauniquenamei.e.Port_Engine

/vessels/<RegExp>/propulsion/<RegExp>

Description:Thisregexpatternisusedforvalidationoftheidentifierforthepropulsionunit


62

/vessels/<RegExp>/propulsion/<RegExp>/label

Description:Humanreadablelabelforthepropulsionunit

/vessels/<RegExp>/propulsion/<RegExp>/state

Description:Thecurrentstateoftheengine

/vessels/<RegExp>/propulsion/<RegExp>/revolutions

Units:Hz(Hertz)

Description:Enginerevolutions(x60forRPM)

/vessels/<RegExp>/propulsion/<RegExp>/temperature

Units:K(Kelvin)

Description:Enginetemperature

/vessels/<RegExp>/propulsion/<RegExp>/oilTemperature

Units:K(Kelvin)

Description:Oiltemperature

/vessels/<RegExp>/propulsion/<RegExp>/oilPressure

Units:Pa(Pascal)

Description:Oilpressure

/vessels/<RegExp>/propulsion/<RegExp>/alternatorVoltage

Units:V(Volt)

Description:Alternatorvoltage

/vessels/<RegExp>/propulsion/<RegExp>/runTime

Units:s(Second)

Description:Totalrunningtimeforengine(EngineHoursinseconds)

/vessels/<RegExp>/propulsion/<RegExp>/coolantTemperature


63

Units:K(Kelvin)

Description:Coolanttemperature

/vessels/<RegExp>/propulsion/<RegExp>/coolantPressure

Units:Pa(Pascal)

Description:Coolantpressure

/vessels/<RegExp>/propulsion/<RegExp>/boostPressure

Units:Pa(Pascal)

Description:Engineboost(turbo,supercharger)pressure

/vessels/<RegExp>/propulsion/<RegExp>/intakeManifoldTemperature

Units:K(Kelvin)

Description:Intakemanifoldtemperature

/vessels/<RegExp>/propulsion/<RegExp>/engineLoad

Units:ratio(Ratio)

Description:Engineloadratio,0<=ratio<=1,1is100%

/vessels/<RegExp>/propulsion/<RegExp>/engineTorque

Units:ratio(Ratio)

Description:Enginetorqueratio,0<=ratio<=1,1is100%

/vessels/<RegExp>/propulsion/<RegExp>/transmission

Description:Thetransmission(gearbox)ofthenamedengine

/vessels/<RegExp>/propulsion/<RegExp>/transmission/gear

Description:Currentlyselectedgeartheengineisini.e.Forward,Reverse,etc.

/vessels/<RegExp>/propulsion/<RegExp>/transmission/gearRatio

Units:ratio(Ratio)


64

Description:Gearratio,enginerotationsperpropellershaftrotation

/vessels/<RegExp>/propulsion/<RegExp>/transmission/oilTemperature

Units:K(Kelvin)

Description:Oiltemperature

/vessels/<RegExp>/propulsion/<RegExp>/transmission/oilPressure

Units:Pa(Pascal)

Description:Oilpressure

/vessels/<RegExp>/propulsion/<RegExp>/drive

Description:Dataabouttheengine'sdrive.

/vessels/<RegExp>/propulsion/<RegExp>/drive/type

Description:Thetypeofdrivetheboathasi.eOutboard,shaft,jet,etc.

Enumvalues:

saildriveshaftoutboardjetpodother

/vessels/<RegExp>/propulsion/<RegExp>/drive/trimState

Units:ratio(Ratio)

Description:Trim/tiltstate,0<=ratio<=1,1is100%up

/vessels/<RegExp>/propulsion/<RegExp>/drive/thrustAngle

Units:rad(Radian)

Description:Currentthrustangleforsteerabledrives,+veisthrusttoStarboard

/vessels/<RegExp>/propulsion/<RegExp>/drive/propeller

Description:Dataaboutthedrive'spropeller(pitchandslip)


65

/vessels/<RegExp>/propulsion/<RegExp>/fuel

Description:Dataabouttheengine'sFuelSupply

/vessels/<RegExp>/propulsion/<RegExp>/fuel/type

Description:Fueltype

Enumvalues:

dieselpetrolelectriccoal/woodother

/vessels/<RegExp>/propulsion/<RegExp>/fuel/used

Units:m3(Cubicmeter)

Description:Usedfuelsincelastreset.Resettingisatuserdiscretion

/vessels/<RegExp>/propulsion/<RegExp>/fuel/pressure

Units:Pa(Pascal)

Description:Fuelpressure

/vessels/<RegExp>/propulsion/<RegExp>/fuel/rate

Units:m3/s(Cubicmeterpersecond)

Description:Fuelrateofconsumption

/vessels/<RegExp>/propulsion/<RegExp>/fuel/economyRate


Description:Economyfuelrateofconsumption

/vessels/<RegExp>/propulsion/<RegExp>/fuel/averageRate


Description:Averagefuelrateofconsumption


66

/vessels/<RegExp>/propulsion/<RegExp>/exhaustTemperature

Units:K(Kelvin)

Description:Exhausttemperature

/vessels/<RegExp>/electrical

Title:electrical

Description:Electricaldata,eachelectricaldeviceindentifiedbyauniquenamei.e.Battery_1

/vessels/<RegExp>/electrical/batteries

Description:Dataaboutthevessel'sbatteries

/vessels/<RegExp>/electrical/batteries/<RegExp>

Title:Batterykeyedbyinstanceid

Description:Batteries,oneormany,withinthevessel

/vessels/<RegExp>/electrical/batteries/<RegExp>/name

Description:UniqueIDofdevice(houseBattery,alternator,Generator,solar1,inverter,charger,combiner,etc.)

/vessels/<RegExp>/electrical/batteries/<RegExp>/location

Description:Installedlocationofdeviceonvessel

/vessels/<RegExp>/electrical/batteries/<RegExp>/dateInstalled


Description:Datedevicewasinstalled

/vessels/<RegExp>/electrical/batteries/<RegExp>/manufacturer

Description:[missing]

/vessels/<RegExp>/electrical/batteries/<RegExp>/manufacturer/name

Description:Manufacturer'sname


67

/vessels/<RegExp>/electrical/batteries/<RegExp>/manufacturer/model

Description:Modelorpartnumber

/vessels/<RegExp>/electrical/batteries/<RegExp>/manufacturer/URL

Description:Webreferance/URL

/vessels/<RegExp>/electrical/batteries/<RegExp>/associatedBus

Description:NameofBUSdeviceisassociatedwith

/vessels/<RegExp>/electrical/batteries/<RegExp>/voltage

Units:V(Volt)

Description:Voltagemeasuredatorascloseaspossibletothedevice

/vessels/<RegExp>/electrical/batteries/<RegExp>/voltage/ripple

Units:V(Volt)

Description:DCRipplevoltage

/vessels/<RegExp>/electrical/batteries/<RegExp>/current

Units:A(Ampere)

Description:Currentflowingout(+ve)orin(-ve)tothedevice

/vessels/<RegExp>/electrical/batteries/<RegExp>/temperature

Title:temperature

Units:K(Kelvin)

Description:Temperaturemeasuredwithinoronthedevice

Fields:

warnUpper(Upperoperationaltemperaturelimit),units:K(Kelvin)warnLower(Loweroperationaltemperaturelimit),units:K(Kelvin)faultUpper(Upperfaulttemperaturelimit-devicemaydisable/disconnect),units:K(Kelvin)faultLower(Lowerfaulttemperaturelimit-devicemaydisable/disconnect),units:K(Kelvin)limitDischargeLower(Operationalminimumtemperaturelimitforbatterydischarge),units:K(Kelvin)limitDischargeUpper(Operationalmaximumtemperaturelimitforbatterydischarge),units:K(Kelvin)limitRechargeLower(Operationalminimumtemperaturelimitforbatteryrecharging),units:K(Kelvin)limitRechargeUpper(Operationalmaximumtemperaturelimitforbatteryrecharging),units:K(Kelvin)


68

/vessels/<RegExp>/electrical/batteries/<RegExp>/chemistry

Description:TypeofbatteryFLA,LiFePO4,etc.

/vessels/<RegExp>/electrical/batteries/<RegExp>/capacity

Title:capacity

Description:Dataaboutthebattery'scapacity

/vessels/<RegExp>/electrical/batteries/<RegExp>/capacity/nominal

Units:J(Joule)

Description:Thecapacityofbatteryasspecifiedbythemanufacturer

/vessels/<RegExp>/electrical/batteries/<RegExp>/capacity/actual

Units:J(Joule)

Description:Themeasuredcapacityofbattery.Thismaychangeovertimeandwilllikelydeviatefromthenominalcapacity.

/vessels/<RegExp>/electrical/batteries/<RegExp>/capacity/remaining

Units:J(Joule)

Description:Capacityremaininginbattery

/vessels/<RegExp>/electrical/batteries/<RegExp>/capacity/dischargeLimit

Units:J(Joule)

Description:Minimumcapacitytobeleftinthebatterywhiledischarging

/vessels/<RegExp>/electrical/batteries/<RegExp>/capacity/stateOfCharge

Units:ratio(Ratio)

Description:Stateofcharge,1=100%

/vessels/<RegExp>/electrical/batteries/<RegExp>/capacity/stateOfHealth

Units:ratio(Ratio)

Description:StateofHealth,1=100%


69

/vessels/<RegExp>/electrical/batteries/<RegExp>/capacity/dischargeSinceFull

Units:C(Coulomb)

Description:Cumulativedischargesincebatterywaslastfull

/vessels/<RegExp>/electrical/batteries/<RegExp>/capacity/timeRemaining

Units:s(Second)

Description:Timetodischargetodischargelimitatcurrentrate

/vessels/<RegExp>/electrical/batteries/<RegExp>/lifetimeDischarge

Units:C(Coulomb)

Description:Cumulativechargedischargedfrombatteryoveroperationallifetimeofbattery

/vessels/<RegExp>/electrical/batteries/<RegExp>/lifetimeRecharge

Units:C(Coulomb)

Description:Cumulativechargerechargedintobatteryoveroperationallifetimeofbattery

/vessels/<RegExp>/electrical/inverters

Description:DataabouttheInverterthathasbothDCandACqualities

/vessels/<RegExp>/electrical/inverters/<RegExp>

Title:Inverter

Description:DCtoACinverter,oneormany,withinthevessel

/vessels/<RegExp>/electrical/inverters/<RegExp>/name


/vessels/<RegExp>/electrical/inverters/<RegExp>/location


/vessels/<RegExp>/electrical/inverters/<RegExp>/dateInstalled


70



/vessels/<RegExp>/electrical/inverters/<RegExp>/manufacturer


/vessels/<RegExp>/electrical/inverters/<RegExp>/manufacturer/name


/vessels/<RegExp>/electrical/inverters/<RegExp>/manufacturer/model


/vessels/<RegExp>/electrical/inverters/<RegExp>/manufacturer/URL


/vessels/<RegExp>/electrical/inverters/<RegExp>/dc

Title:DCQualities

Description:DCcommonqualities

/vessels/<RegExp>/electrical/inverters/<RegExp>/dc/associatedBus


/vessels/<RegExp>/electrical/inverters/<RegExp>/dc/voltage

Units:V(Volt)


/vessels/<RegExp>/electrical/inverters/<RegExp>/dc/voltage/ripple

Units:V(Volt)


/vessels/<RegExp>/electrical/inverters/<RegExp>/dc/current


71

Units:A(Ampere)


/vessels/<RegExp>/electrical/inverters/<RegExp>/dc/temperature

Title:temperature

Units:K(Kelvin)


Fields:

warnUpper(Upperoperationaltemperaturelimit),units:K(Kelvin)warnLower(Loweroperationaltemperaturelimit),units:K(Kelvin)faultUpper(Upperfaulttemperaturelimit-devicemaydisable/disconnect),units:K(Kelvin)faultLower(Lowerfaulttemperaturelimit-devicemaydisable/disconnect),units:K(Kelvin)

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac

Title:ACQualities

Description:ACequipmentcommonqualities

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/associatedBus


/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/lineNeutralVoltage

Units:V(Volt)

Description:RMSvoltagemeasuredbetweenphaseandneutral

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/lineLineVoltage

Units:V(Volt)

Description:RMSvoltagemeasuredbetweenphases

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/current

Units:A(Ampere)

Description:RMScurrent


72

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/frequency

Units:Hz(Hertz)

Description:ACfrequency.

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/reactivePower

Units:W(Watt)

Description:Reactivepower

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/powerFactor

Description:Powerfactor

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/powerFactorLagging

Description:Lead/lagstatus.

Enumvalues:

leadinglaggingerrornotavailable

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/realPower

Units:W(Watt)

Description:Realpower.

/vessels/<RegExp>/electrical/inverters/<RegExp>/ac/apparentPower

Units:W(Watt)

Description:Apparentpower.

/vessels/<RegExp>/electrical/inverters/<RegExp>/inverterMode

Description:Modeofinverter

/vessels/<RegExp>/electrical/chargers

Description:DataaboutACsourcedbatterycharger


73

/vessels/<RegExp>/electrical/chargers/<RegExp>

Title:Charger

Description:Batterycharger

/vessels/<RegExp>/electrical/chargers/<RegExp>/name


/vessels/<RegExp>/electrical/chargers/<RegExp>/location


/vessels/<RegExp>/electrical/chargers/<RegExp>/dateInstalled



/vessels/<RegExp>/electrical/chargers/<RegExp>/manufacturer


/vessels/<RegExp>/electrical/chargers/<RegExp>/manufacturer/name


/vessels/<RegExp>/electrical/chargers/<RegExp>/manufacturer/model


/vessels/<RegExp>/electrical/chargers/<RegExp>/manufacturer/URL


/vessels/<RegExp>/electrical/chargers/<RegExp>/associatedBus


/vessels/<RegExp>/electrical/chargers/<RegExp>/voltage


74

Units:V(Volt)


/vessels/<RegExp>/electrical/chargers/<RegExp>/voltage/ripple

Units:V(Volt)


/vessels/<RegExp>/electrical/chargers/<RegExp>/current

Units:A(Ampere)


/vessels/<RegExp>/electrical/chargers/<RegExp>/temperature

Title:temperature

Units:K(Kelvin)


Fields:


/vessels/<RegExp>/electrical/chargers/<RegExp>/chargingAlgorithm

Description:Algorithmbeingusedbythecharger

/vessels/<RegExp>/electrical/chargers/<RegExp>/chargerRole

Description:Howischargingsourceconfigured?Standalone,orinsyncwithanothercharger?

/vessels/<RegExp>/electrical/chargers/<RegExp>/chargingMode

Description:Chargingmodei.e.float,overcharge,etc.

/vessels/<RegExp>/electrical/chargers/<RegExp>/setpointVoltage

Units:V(Volt)


75

Description:Targetregulationvoltage

/vessels/<RegExp>/electrical/chargers/<RegExp>/setpointCurrent

Units:A(Ampere)

Description:Targetcurrentlimit

/vessels/<RegExp>/electrical/alternators

Description:DataaboutanAlternatorchargingdevice

/vessels/<RegExp>/electrical/alternators/<RegExp>

Title:Alternator

Description:Mechanicallydrivenalternator,includesdynamos

/vessels/<RegExp>/electrical/alternators/<RegExp>/name


/vessels/<RegExp>/electrical/alternators/<RegExp>/location


/vessels/<RegExp>/electrical/alternators/<RegExp>/dateInstalled



/vessels/<RegExp>/electrical/alternators/<RegExp>/manufacturer


/vessels/<RegExp>/electrical/alternators/<RegExp>/manufacturer/name


/vessels/<RegExp>/electrical/alternators/<RegExp>/manufacturer/model



76

/vessels/<RegExp>/electrical/alternators/<RegExp>/manufacturer/URL


/vessels/<RegExp>/electrical/alternators/<RegExp>/associatedBus


/vessels/<RegExp>/electrical/alternators/<RegExp>/voltage

Units:V(Volt)


/vessels/<RegExp>/electrical/alternators/<RegExp>/voltage/ripple

Units:V(Volt)


/vessels/<RegExp>/electrical/alternators/<RegExp>/current

Units:A(Ampere)


/vessels/<RegExp>/electrical/alternators/<RegExp>/temperature

Title:temperature

Units:K(Kelvin)


Fields:


/vessels/<RegExp>/electrical/alternators/<RegExp>/chargingAlgorithm



77

/vessels/<RegExp>/electrical/alternators/<RegExp>/chargerRole


/vessels/<RegExp>/electrical/alternators/<RegExp>/chargingMode


/vessels/<RegExp>/electrical/alternators/<RegExp>/setpointVoltage

Units:V(Volt)


/vessels/<RegExp>/electrical/alternators/<RegExp>/setpointCurrent

Units:A(Ampere)


/vessels/<RegExp>/electrical/alternators/<RegExp>/revolutions

Units:Hz(Hertz)

Description:Alternatorrevolutionspersecond(x60forRPM)

/vessels/<RegExp>/electrical/alternators/<RegExp>/pulleyRatio

Units:ratio(Ratio)

Description:Mechanicalpulleyratioofdrivingsource(UsedtobackcalculateengineRPMs)

/vessels/<RegExp>/electrical/alternators/<RegExp>/fieldDrive

Units:%(undefined)

Description:%(0..100)offieldvoltageapplied

/vessels/<RegExp>/electrical/alternators/<RegExp>/regulatorTemperature

Units:K(Kelvin)

Description:Currenttemperatureofcriticalregulatorcomponents

/vessels/<RegExp>/electrical/solar


78

Description:DataaboutSolarchargingdevice(s)

/vessels/<RegExp>/electrical/solar/<RegExp>

Title:Solar

Description:Photovoltaicchargingdevices

/vessels/<RegExp>/electrical/solar/<RegExp>/name


/vessels/<RegExp>/electrical/solar/<RegExp>/location


/vessels/<RegExp>/electrical/solar/<RegExp>/dateInstalled



/vessels/<RegExp>/electrical/solar/<RegExp>/manufacturer


/vessels/<RegExp>/electrical/solar/<RegExp>/manufacturer/name


/vessels/<RegExp>/electrical/solar/<RegExp>/manufacturer/model


/vessels/<RegExp>/electrical/solar/<RegExp>/manufacturer/URL


/vessels/<RegExp>/electrical/solar/<RegExp>/associatedBus



79

/vessels/<RegExp>/electrical/solar/<RegExp>/voltage

Units:V(Volt)


/vessels/<RegExp>/electrical/solar/<RegExp>/voltage/ripple

Units:V(Volt)


/vessels/<RegExp>/electrical/solar/<RegExp>/current

Units:A(Ampere)


/vessels/<RegExp>/electrical/solar/<RegExp>/temperature

Title:temperature

Units:K(Kelvin)


Fields:


/vessels/<RegExp>/electrical/solar/<RegExp>/chargingAlgorithm


/vessels/<RegExp>/electrical/solar/<RegExp>/chargerRole


/vessels/<RegExp>/electrical/solar/<RegExp>/chargingMode


/vessels/<RegExp>/electrical/solar/<RegExp>/setpointVoltage


80

Units:V(Volt)


/vessels/<RegExp>/electrical/solar/<RegExp>/setpointCurrent

Units:A(Ampere)


/vessels/<RegExp>/electrical/solar/<RegExp>/controllerMode

Description:Thecurrentstateoftheengine

/vessels/<RegExp>/electrical/solar/<RegExp>/panelVoltage

Units:V(Volt)

Description:VoltagebeingsuppliedfromSolarPanelstocontroller

/vessels/<RegExp>/electrical/solar/<RegExp>/panelCurrent

Units:A(Ampere)

Description:AmperagebeingsuppliedfromSolarPanelstocontroller

/vessels/<RegExp>/electrical/solar/<RegExp>/panelTemperature

Units:K(Kelvin)

Description:Temperatureofpanels

/vessels/<RegExp>/electrical/solar/<RegExp>/load

Description:Stateofloadportoncontroller(ifapplicable)

/vessels/<RegExp>/electrical/solar/<RegExp>/loadCurrent

Units:A(Ampere)

Description:Amperagebeingsuppliedtoloaddirectlyconnectedtocontroller

/vessels/<RegExp>/electrical/ac

Description:ACbuses


81

/vessels/<RegExp>/electrical/ac/<RegExp>

Title:ACBuskeyedbyinstanceid

Description:ACBus,oneormany,withinthevessel

/vessels/<RegExp>/electrical/ac/<RegExp>/name


/vessels/<RegExp>/electrical/ac/<RegExp>/location


/vessels/<RegExp>/electrical/ac/<RegExp>/dateInstalled



/vessels/<RegExp>/electrical/ac/<RegExp>/manufacturer


/vessels/<RegExp>/electrical/ac/<RegExp>/manufacturer/name


/vessels/<RegExp>/electrical/ac/<RegExp>/manufacturer/model


/vessels/<RegExp>/electrical/ac/<RegExp>/manufacturer/URL


/vessels/<RegExp>/electrical/ac/<RegExp>/phase

Description:SingleorA,BorCin3Phasesystems

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])


82

Title:ACQualities

Description:ACequipmentcommonqualities

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/associatedBus


/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/lineNeutralVoltage

Units:V(Volt)

Description:RMSvoltagemeasuredbetweenphaseandneutral

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/lineLineVoltage

Units:V(Volt)

Description:RMSvoltagemeasuredbetweenphases

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/current

Units:A(Ampere)

Description:RMScurrent

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/frequency

Units:Hz(Hertz)

Description:ACfrequency.

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/reactivePower

Units:W(Watt)

Description:Reactivepower

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/powerFactor

Description:Powerfactor

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/powerFactorLagging

Description:Lead/lagstatus.


83

Enumvalues:

leadinglaggingerrornotavailable

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/realPower

Units:W(Watt)

Description:Realpower.

/vessels/<RegExp>/electrical/ac/<RegExp>/phase/(single)|([A-C])/apparentPower

Units:W(Watt)

Description:Apparentpower.

/vessels/<RegExp>/notifications

Title:notifications

Description:Notificationscurrentlyraised.Majorcategorieshavewell-definednames,butthetreecanbeextendedbyanyhierarchicalstructure

/vessels/<RegExp>/notifications/mob

Description:Manoverboard


methodstatemessage

/vessels/<RegExp>/notifications/fire

Description:Fireonboard


methodstatemessage

/vessels/<RegExp>/notifications/sinking


84

Description:Vesselissinking


methodstatemessage

/vessels/<RegExp>/notifications/flooding

Description:Vesselisflooding


methodstatemessage

/vessels/<RegExp>/notifications/collision

Description:Incollisionwithanothervesselorobject


methodstatemessage

/vessels/<RegExp>/notifications/grounding

Description:Vesselgrounding


methodstatemessage

/vessels/<RegExp>/notifications/listing

Description:Vesselislisting


methodstatemessage

/vessels/<RegExp>/notifications/adrift


85

Description:Vesselisadrift


methodstatemessage

/vessels/<RegExp>/notifications/piracy

Description:Underattackordangerfrompirates


methodstatemessage

/vessels/<RegExp>/notifications/abandon

Description:Abandonship


methodstatemessage

/vessels/<RegExp>/notifications/<RegExp>

Description:Thisregexpatternisusedforvalidationofthepathofthealarm

/vessels/<RegExp>/steering

Title:steering

Description:Vesselsteeringdataforsteeringcontrols(notAutopilot'NavData')

/vessels/<RegExp>/steering/rudderAngle

Units:rad(Radian)

Description:Currentrudderangle,+veisruddertoStarboard

/vessels/<RegExp>/steering/rudderAngleTarget

Units:rad(Radian)

Description:Theangletheruddershouldmoveto,+veisruddertoStarboard


86

/vessels/<RegExp>/steering/autopilot

Title:autopilot

Description:Autopilotdata

/vessels/<RegExp>/steering/autopilot/state

Description:Autopilotstate

/vessels/<RegExp>/steering/autopilot/mode

Description:Operationalmode

/vessels/<RegExp>/steering/autopilot/target

Title:target

Description:Autopilottarget

/vessels/<RegExp>/steering/autopilot/target/windAngleApparent

Units:rad(Radian)

Description:Targetangletosteer,relativetoApparentwind+port-starboard

/vessels/<RegExp>/steering/autopilot/target/headingTrue

Units:rad(Radian)

Description:Targetheadingforautopilot,relativetoNorth

/vessels/<RegExp>/steering/autopilot/target/headingMagnetic

Units:rad(Radian)

Description:Targetheadingforautopilot,relativetoMagneticNorth

/vessels/<RegExp>/steering/autopilot/deadZone

Units:rad(Radian)

Description:Deadzonetoignoreforruddercorrections


87

/vessels/<RegExp>/steering/autopilot/backlash

Units:rad(Radian)

Description:Slackintherudderdrivemechanism

/vessels/<RegExp>/steering/autopilot/gain

Description:Auto-pilotgain,highernumberequalsmoreruddermovementforagiventurn

/vessels/<RegExp>/steering/autopilot/maxDriveCurrent

Units:A(Ampere)

Description:Maximumcurrenttousetodriveservo

/vessels/<RegExp>/steering/autopilot/maxDriveRate


Description:Maximumrudderrotationspeed

/vessels/<RegExp>/steering/autopilot/portLock

Units:rad(Radian)

Description:Positionofservoonportlock

/vessels/<RegExp>/steering/autopilot/starboardLock

Units:rad(Radian)

Description:Positionofservoonstarboardlock

/vessels/<RegExp>/tanks

Title:tanks

Description:Tankdata,eachtankindentifiedbyauniquenamei.e.FreshWater_2

/vessels/<RegExp>/tanks/freshWater

Description:Freshwatertank(drinking)

/vessels/<RegExp>/tanks/freshWater/<RegExp>


88

Description:Tank,oneormany,withinthevessel

/vessels/<RegExp>/tanks/freshWater/<RegExp>/name

Description:Thenameofthetank.Usefulifmultipletanksofacertaintypeareonboard

/vessels/<RegExp>/tanks/freshWater/<RegExp>/type

Description:Thetypeoftank

Enumvalues:

petrolfreshwatergreywaterblackwaterholdinglpgdieselliveWellballastrum

/vessels/<RegExp>/tanks/freshWater/<RegExp>/capacity


Description:Totalcapacity

/vessels/<RegExp>/tanks/freshWater/<RegExp>/currentLevel

Units:ratio(Ratio)

Description:Leveloffluidintank0-100%

/vessels/<RegExp>/tanks/freshWater/<RegExp>/currentVolume


Description:Volumeoffluidintank

/vessels/<RegExp>/tanks/freshWater/<RegExp>/pressure

Units:Pa(Pascal)

Description:Pressureofcontentsintank,especiallyLPG/gas


89

/vessels/<RegExp>/tanks/freshWater/<RegExp>/temperature

Units:K(Kelvin)

Description:Temperatureoftank,especiallycryogenicorLPG/gas

/vessels/<RegExp>/tanks/freshWater/<RegExp>/viscosity

Units:Pa/s(undefined)

Description:Viscosityofthefluid,ifapplicable

/vessels/<RegExp>/tanks/freshWater/<RegExp>/extinguishant

Description:Thepreferredextinguishanttodouseafireinthistank

/vessels/<RegExp>/tanks/wasteWater

Description:Wastewatertank(greywater)

/vessels/<RegExp>/tanks/wasteWater/<RegExp>


/vessels/<RegExp>/tanks/wasteWater/<RegExp>/name


/vessels/<RegExp>/tanks/wasteWater/<RegExp>/type


Enumvalues:



90

/vessels/<RegExp>/tanks/wasteWater/<RegExp>/capacity



/vessels/<RegExp>/tanks/wasteWater/<RegExp>/currentLevel

Units:ratio(Ratio)


/vessels/<RegExp>/tanks/wasteWater/<RegExp>/currentVolume



/vessels/<RegExp>/tanks/wasteWater/<RegExp>/pressure

Units:Pa(Pascal)


/vessels/<RegExp>/tanks/wasteWater/<RegExp>/temperature

Units:K(Kelvin)


/vessels/<RegExp>/tanks/wasteWater/<RegExp>/viscosity



/vessels/<RegExp>/tanks/wasteWater/<RegExp>/extinguishant


/vessels/<RegExp>/tanks/blackWater

Description:Blackwatertank(sewage)

/vessels/<RegExp>/tanks/blackWater/<RegExp>


91


/vessels/<RegExp>/tanks/blackWater/<RegExp>/name


/vessels/<RegExp>/tanks/blackWater/<RegExp>/type


Enumvalues:


/vessels/<RegExp>/tanks/blackWater/<RegExp>/capacity



/vessels/<RegExp>/tanks/blackWater/<RegExp>/currentLevel

Units:ratio(Ratio)


/vessels/<RegExp>/tanks/blackWater/<RegExp>/currentVolume



/vessels/<RegExp>/tanks/blackWater/<RegExp>/pressure

Units:Pa(Pascal)



92

/vessels/<RegExp>/tanks/blackWater/<RegExp>/temperature

Units:K(Kelvin)


/vessels/<RegExp>/tanks/blackWater/<RegExp>/viscosity



/vessels/<RegExp>/tanks/blackWater/<RegExp>/extinguishant


/vessels/<RegExp>/tanks/fuel

Description:Fueltank(petrolordiesel)

/vessels/<RegExp>/tanks/fuel/<RegExp>


/vessels/<RegExp>/tanks/fuel/<RegExp>/name


/vessels/<RegExp>/tanks/fuel/<RegExp>/type


Enumvalues:



93

/vessels/<RegExp>/tanks/fuel/<RegExp>/capacity



/vessels/<RegExp>/tanks/fuel/<RegExp>/currentLevel

Units:ratio(Ratio)


/vessels/<RegExp>/tanks/fuel/<RegExp>/currentVolume



/vessels/<RegExp>/tanks/fuel/<RegExp>/pressure

Units:Pa(Pascal)


/vessels/<RegExp>/tanks/fuel/<RegExp>/temperature

Units:K(Kelvin)


/vessels/<RegExp>/tanks/fuel/<RegExp>/viscosity



/vessels/<RegExp>/tanks/fuel/<RegExp>/extinguishant


/vessels/<RegExp>/tanks/lubrication

Description:Lubricationtank(oilorgrease)

/vessels/<RegExp>/tanks/lubrication/<RegExp>


94


/vessels/<RegExp>/tanks/lubrication/<RegExp>/name


/vessels/<RegExp>/tanks/lubrication/<RegExp>/type


Enumvalues:


/vessels/<RegExp>/tanks/lubrication/<RegExp>/capacity



/vessels/<RegExp>/tanks/lubrication/<RegExp>/currentLevel

Units:ratio(Ratio)


/vessels/<RegExp>/tanks/lubrication/<RegExp>/currentVolume



/vessels/<RegExp>/tanks/lubrication/<RegExp>/pressure

Units:Pa(Pascal)



95

/vessels/<RegExp>/tanks/lubrication/<RegExp>/temperature

Units:K(Kelvin)


/vessels/<RegExp>/tanks/lubrication/<RegExp>/viscosity



/vessels/<RegExp>/tanks/lubrication/<RegExp>/extinguishant


/vessels/<RegExp>/tanks/liveWell

Description:Livetank(fish)

/vessels/<RegExp>/tanks/liveWell/<RegExp>


/vessels/<RegExp>/tanks/liveWell/<RegExp>/name


/vessels/<RegExp>/tanks/liveWell/<RegExp>/type


Enumvalues:



96

/vessels/<RegExp>/tanks/liveWell/<RegExp>/capacity



/vessels/<RegExp>/tanks/liveWell/<RegExp>/currentLevel

Units:ratio(Ratio)


/vessels/<RegExp>/tanks/liveWell/<RegExp>/currentVolume



/vessels/<RegExp>/tanks/liveWell/<RegExp>/pressure

Units:Pa(Pascal)


/vessels/<RegExp>/tanks/liveWell/<RegExp>/temperature

Units:K(Kelvin)


/vessels/<RegExp>/tanks/liveWell/<RegExp>/viscosity



/vessels/<RegExp>/tanks/liveWell/<RegExp>/extinguishant


/vessels/<RegExp>/tanks/gas

Description:Lpg/propaneandothergases

/vessels/<RegExp>/tanks/gas/<RegExp>


97


/vessels/<RegExp>/tanks/gas/<RegExp>/name


/vessels/<RegExp>/tanks/gas/<RegExp>/type


Enumvalues:


/vessels/<RegExp>/tanks/gas/<RegExp>/capacity



/vessels/<RegExp>/tanks/gas/<RegExp>/currentLevel

Units:ratio(Ratio)


/vessels/<RegExp>/tanks/gas/<RegExp>/currentVolume



/vessels/<RegExp>/tanks/gas/<RegExp>/pressure

Units:Pa(Pascal)



98

/vessels/<RegExp>/tanks/gas/<RegExp>/temperature

Units:K(Kelvin)


/vessels/<RegExp>/tanks/gas/<RegExp>/viscosity



/vessels/<RegExp>/tanks/gas/<RegExp>/extinguishant


/vessels/<RegExp>/tanks/ballast

Description:Ballasttanks

/vessels/<RegExp>/tanks/ballast/<RegExp>


/vessels/<RegExp>/tanks/ballast/<RegExp>/name


/vessels/<RegExp>/tanks/ballast/<RegExp>/type


Enumvalues:



99

/vessels/<RegExp>/tanks/ballast/<RegExp>/capacity



/vessels/<RegExp>/tanks/ballast/<RegExp>/currentLevel

Units:ratio(Ratio)


/vessels/<RegExp>/tanks/ballast/<RegExp>/currentVolume



/vessels/<RegExp>/tanks/ballast/<RegExp>/pressure

Units:Pa(Pascal)


/vessels/<RegExp>/tanks/ballast/<RegExp>/temperature

Units:K(Kelvin)


/vessels/<RegExp>/tanks/ballast/<RegExp>/viscosity



/vessels/<RegExp>/tanks/ballast/<RegExp>/extinguishant


/vessels/<RegExp>/design

Title:design

Description:Design/dimensionaldataofthisvessel


100

/vessels/<RegExp>/design/displacement

Units:kg(Kilogram)

Description:Thedisplacementofthevessel

/vessels/<RegExp>/design/aisShipType

Description:Theaisshiptypeseehttp://www.bosunsmate.org/ais/message5.php


idname

/vessels/<RegExp>/design/draft

Title:draft

Description:Thedraftofthevessel


minimum(m)maximum(m)current(m)canoe(m)

/vessels/<RegExp>/design/length

Title:length

Description:Thevariouslengthsofthevessel


overall(m)hull(m)waterline(m)

/vessels/<RegExp>/design/keel

Title:keel

Description:Informationaboutthevessel'skeel

Fields:

type(Thetypeofkeel.),enum:

longfinflare


101

http://www.bosunsmate.org/ais/message5.php

bulbwingcenterboardkantingliftingdaggerboard

/vessels/<RegExp>/design/keel/angle

Units:rad(Radian)

Description:Anumberindicatingatwhichanglethekeelcurrentlyis(incaseofacantingkeel),negativetoport.

/vessels/<RegExp>/design/keel/lift

Units:ratio(Ratio)

Description:Inthecaseofaliftingkeel,centreboardordaggerboard,thepartofthekeelwhichisextended.0is'allthewayup'and1is'allthewaydown'.0.8wouldbe80%down.

/vessels/<RegExp>/design/beam

Units:m(Meter)

Description:Beamlength

/vessels/<RegExp>/design/airHeight

Units:m(Meter)

Description:Totalheightofthevessel

/vessels/<RegExp>/design/rigging

Title:rigging

Description:Informationaboutthevessel'srigging

Fields:

configuration(Theconfigurationoftherigging)masts(Thenumberofmastsonthevessel.)

/vessels/<RegExp>/sails

Title:sails

Description:Sailsdata


102

/vessels/<RegExp>/sails/inventory

Description:Anobjectcontainingadescriptionofeachsailavailabletothevesselcrew

/vessels/<RegExp>/sails/inventory/<RegExp>

Description:'sail'datatype.

Fields:

name(Anuniqueidentifierbywhichthecrewidentifiesasail)type(Thetypeofsail)material(Thematerialthesailismadefrom(optional))brand(Thebrandofthesail(optional))active(Indicateswetherthissailiscurrentlyinuseornot)area(Thetotalareaofthissailinsquaremeters),units:m2(Squaremeter)minimumWind(Theminimumwindspeedthissailcanbeusedwith),units:m/s(Meterspersecond)maximumWind(Themaximumwindspeedthissailcanbeusedwith),units:m/s(Meterspersecond)

/vessels/<RegExp>/sails/area

Description:Anobjectcontaininginformationaboutthevessels'sails.

/vessels/<RegExp>/sails/area/total

Units:m2(Squaremeter)

Description:Thetotalareaofallsailsonthevessel

/vessels/<RegExp>/sails/area/active

Units:m2(Squaremeter)

Description:Thetotalareaofthesailscurrentlyinuseonthevessel

/vessels/<RegExp>/sensors

Title:sensors

Description:Sensors,theirstate,anddata.

/vessels/<RegExp>/sensors/<RegExp>

Title:sensor

Description:ThisregexpatternisusedforvalidationUUIDidentifierforthesensor


103

/vessels/<RegExp>/sensors/<RegExp>/name

Description:Thecommonnameofthesensor

/vessels/<RegExp>/sensors/<RegExp>/sensorType

Description:Thedatamodeldefinitionofthesensordata.FIXME-needtocreateadefinitionslibofsensordatamodeltypes

/vessels/<RegExp>/sensors/<RegExp>/sensorData

Description:Thedataofthesensordata.FIXME-needtorefthedefinitionsofsensortypes

/vessels/<RegExp>/sensors/<RegExp>/fromBow

Description:Thedistancefromthebowtothesensorlocation

/vessels/<RegExp>/sensors/<RegExp>/fromCenter

Description:Thedistancefromthecenterlinetothesensorlocation,-vetostarboard,+vetoport

/vessels/<RegExp>/performance

Title:performance

Description:PerformanceSailingdataincludingVMG,PolarSpeed,tackangle,etc.

/vessels/<RegExp>/performance/polarSpeed


Description:Thecurrentpolarspeedbasedoncurrentpolardiagram,WindSpeedTrueandangleTrueWater.

/vessels/<RegExp>/performance/polarSpeedRatio

Units:ratio(Ratio)

Description:Theratioofcurrentspeedthroughwatertothepolarspeed.

/vessels/<RegExp>/performance/velocityMadeGood



104

Description:Thecurrentvelocitymadegoodderivedfromthespeedthroughwaterandappearantwindangle.Apositivevalueisheadingtoupwind,negativetodownwind.

/vessels/<RegExp>/performance/velocityMadeGoodToWaypoint


Description:ThecurrentvelocitymadegoodtothenextwaypointderivedfromthespeedOverGround,courseOverGround.

/vessels/<RegExp>/performance/beatAngle

Units:rad(Radian)

Description:ThetruewindbeatangleforthebestvelocitymadegoodbasedoncurrentcurrentpolardiagramandWindSpeedTrue.

/vessels/<RegExp>/performance/beatAngleVelocityMadeGood


Description:Thevelocitymadegoodforthebeatangle.

/vessels/<RegExp>/performance/beatAngleTargetSpeed


Description:Thetargetspeedforthebeatangle.

/vessels/<RegExp>/performance/gybeAngle

Units:rad(Radian)

Description:ThetruewindgybeangleforthebestvelocitymadegooddownwindbasedoncurrentpolardiagramandWindSpeedTrue.

/vessels/<RegExp>/performance/gybeAngleVelocityMadeGood


Description:Thevelocitymadegoodforthegybeangle

/vessels/<RegExp>/performance/gybeAngleTargetSpeed


Description:Thetargetspeedforthegybeangle.


105

/vessels/<RegExp>/performance/targetAngle

Units:rad(Radian)

Description:ThetruewindgybeorbeatangleforthebestvelocitymadegooddownwindorupwindbasedoncurrentpolardiagramandWindSpeedTrue.

/vessels/<RegExp>/performance/targetSpeed


Description:Thetargetspeedforthebeatangleorgybeangle,whicheverisapplicable.

/vessels/<RegExp>/performance/leeway

Units:rad(Radian)

Description:Currentleeway

/vessels/<RegExp>/performance/tackMagnetic

Units:rad(Radian)

Description:Magneticheadingonoppositetack.

/vessels/<RegExp>/performance/tackTrue

Units:rad(Radian)

Description:Trueheadingonoppositetack.


106

/self

Description:Thisholdsthecontext(prefix+UUID,MMSIorURLindotnotation)oftheserver'sselfobject.

/aircraft

Description:Awrapperobjectforaircraft,primarilyintendedforSARaircraftinrelationtomarinesearchandrescue.Forclarityaboutseaplanesetc,ifitCANfly,itsanaircraft.

/aircraft/<RegExp>

Title:aircraft

Description:ThisregexpatternisusedforvalidationofanMMSIorSignalKUUIDidentifierfortheaircraft.Examples:urn:mrn:imo:mmsi:111099999urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d

/aircraft/<RegExp>/url

Description:URLbasedidentityoftheaircraft,ifavailable.

/aircraft/<RegExp>/mmsi

Description:MMSInumberoftheaircraft,ifavailable.

/aircraft/<RegExp>/uuid


/aircraft/<RegExp>/flag

Description:Thecountryofaircraftregistration,orflagstateoftheaircraft

/aircraft/<RegExp>/base

Description:Thehomebaseoftheaircraft

/aircraft/<RegExp>/registrations

Description:Thevariousregistrationsoftheaircraft.


107

/aircraft/<RegExp>/registrations/imo

Description:TheIMOnumberoftheaircraft.

/aircraft/<RegExp>/registrations/national

Description:Thenationalregistrationnumberoftheaircraft.

/aircraft/<RegExp>/registrations/national/<RegExp>


/aircraft/<RegExp>/registrations/national/<RegExp>/country

Description:TheISO3166-2countrycode.

/aircraft/<RegExp>/registrations/national/<RegExp>/registration


/aircraft/<RegExp>/registrations/national/<RegExp>/description


/aircraft/<RegExp>/registrations/other

Description:Otherregistrationorpermitsfortheaircraft.

/aircraft/<RegExp>/registrations/other/<RegExp>


/aircraft/<RegExp>/registrations/other/<RegExp>/registration


/aircraft/<RegExp>/registrations/other/<RegExp>/description



108

/aircraft/<RegExp>/communication

Title:communication


/aircraft/<RegExp>/communication/callsignVhf


/aircraft/<RegExp>/communication/callsignHf


/aircraft/<RegExp>/communication/phoneNumber


/aircraft/<RegExp>/communication/emailHf


/aircraft/<RegExp>/communication/email


/aircraft/<RegExp>/communication/satPhoneNumber


/aircraft/<RegExp>/communication/skipperName


/aircraft/<RegExp>/communication/crewNames


/aircraft/<RegExp>/environment

Title:environment


109


/aircraft/<RegExp>/environment/outside


/aircraft/<RegExp>/environment/outside/temperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/outside/dewPointTemperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/outside/apparentWindChillTemperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/outside/theoreticalWindChillTemperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/outside/heatIndexTemperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/outside/pressure

Units:Pa(Pascal)


/aircraft/<RegExp>/environment/outside/humidity

Units:ratio(Ratio)


110


/aircraft/<RegExp>/environment/outside/airDensity



/aircraft/<RegExp>/environment/outside/illuminance



/aircraft/<RegExp>/environment/inside


/aircraft/<RegExp>/environment/inside/temperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/humidity

Units:ratio(Ratio)


/aircraft/<RegExp>/environment/inside/engineRoom


/aircraft/<RegExp>/environment/inside/engineRoom/temperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/engineRoom/pressure

Units:Pa(Pascal)



111

/aircraft/<RegExp>/environment/inside/engineRoom/relativeHumidity

Units:ratio(Ratio)


/aircraft/<RegExp>/environment/inside/engineRoom/dewPoint

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/engineRoom/airDensity



/aircraft/<RegExp>/environment/inside/engineRoom/illuminance



/aircraft/<RegExp>/environment/inside/mainCabin


/aircraft/<RegExp>/environment/inside/mainCabin/temperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/mainCabin/pressure

Units:Pa(Pascal)


/aircraft/<RegExp>/environment/inside/mainCabin/relativeHumidity

Units:ratio(Ratio)



112

/aircraft/<RegExp>/environment/inside/mainCabin/dewPoint

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/mainCabin/airDensity



/aircraft/<RegExp>/environment/inside/mainCabin/illuminance



/aircraft/<RegExp>/environment/inside/refrigerator


/aircraft/<RegExp>/environment/inside/refrigerator/temperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/refrigerator/pressure

Units:Pa(Pascal)


/aircraft/<RegExp>/environment/inside/refrigerator/relativeHumidity

Units:ratio(Ratio)


/aircraft/<RegExp>/environment/inside/refrigerator/dewPoint

Units:K(Kelvin)



113

/aircraft/<RegExp>/environment/inside/refrigerator/airDensity



/aircraft/<RegExp>/environment/inside/refrigerator/illuminance



/aircraft/<RegExp>/environment/inside/freezer


/aircraft/<RegExp>/environment/inside/freezer/temperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/freezer/pressure

Units:Pa(Pascal)


/aircraft/<RegExp>/environment/inside/freezer/relativeHumidity

Units:ratio(Ratio)


/aircraft/<RegExp>/environment/inside/freezer/dewPoint

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/freezer/airDensity




114

/aircraft/<RegExp>/environment/inside/freezer/illuminance



/aircraft/<RegExp>/environment/inside/heating


/aircraft/<RegExp>/environment/inside/heating/temperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/heating/pressure

Units:Pa(Pascal)


/aircraft/<RegExp>/environment/inside/heating/relativeHumidity

Units:ratio(Ratio)


/aircraft/<RegExp>/environment/inside/heating/dewPoint

Units:K(Kelvin)


/aircraft/<RegExp>/environment/inside/heating/airDensity



/aircraft/<RegExp>/environment/inside/heating/illuminance




115

/aircraft/<RegExp>/environment/water


/aircraft/<RegExp>/environment/water/temperature

Units:K(Kelvin)


/aircraft/<RegExp>/environment/water/salinity

Units:ratio(Ratio)


/aircraft/<RegExp>/environment/depth

Title:depth


/aircraft/<RegExp>/environment/depth/belowKeel

Units:m(Meter)


/aircraft/<RegExp>/environment/depth/belowTransducer

Units:m(Meter)


/aircraft/<RegExp>/environment/depth/belowSurface

Units:m(Meter)


/aircraft/<RegExp>/environment/depth/transducerToKeel

Units:m(Meter)



116

/aircraft/<RegExp>/environment/depth/surfaceToTransducer

Units:m(Meter)


/aircraft/<RegExp>/environment/current

Title:current




/aircraft/<RegExp>/environment/tide

Title:tide


/aircraft/<RegExp>/environment/tide/heightHigh

Units:m(Meter)


/aircraft/<RegExp>/environment/tide/heightNow

Units:m(Meter)


/aircraft/<RegExp>/environment/tide/heightLow

Units:m(Meter)


/aircraft/<RegExp>/environment/tide/timeLow




117

/aircraft/<RegExp>/environment/tide/timeHigh



/aircraft/<RegExp>/environment/heave

Units:m(Meter)


/aircraft/<RegExp>/environment/wind

Title:wind


/aircraft/<RegExp>/environment/wind/angleApparent

Units:rad(Radian)


/aircraft/<RegExp>/environment/wind/angleTrueGround

Units:rad(Radian)


/aircraft/<RegExp>/environment/wind/angleTrueWater

Units:rad(Radian)


/aircraft/<RegExp>/environment/wind/directionChangeAlarm

Units:rad(Radian)


/aircraft/<RegExp>/environment/wind/directionTrue

Units:rad(Radian)



118

/aircraft/<RegExp>/environment/wind/directionMagnetic

Units:rad(Radian)


/aircraft/<RegExp>/environment/wind/speedTrue



/aircraft/<RegExp>/environment/wind/speedOverGround



/aircraft/<RegExp>/environment/wind/speedApparent



/aircraft/<RegExp>/environment/time


Fields:


/aircraft/<RegExp>/environment/mode


/aircraft/<RegExp>/navigation

Title:navigation



119

/aircraft/<RegExp>/navigation/lights



/aircraft/<RegExp>/navigation/courseOverGroundMagnetic

Units:rad(Radian)


/aircraft/<RegExp>/navigation/courseOverGroundTrue

Units:rad(Radian)


/aircraft/<RegExp>/navigation/courseRhumbline

Title:Course


/aircraft/<RegExp>/navigation/courseRhumbline/crossTrackError

Units:m(Meter)


/aircraft/<RegExp>/navigation/courseRhumbline/bearingTrackTrue

Units:rad(Radian)


/aircraft/<RegExp>/navigation/courseRhumbline/bearingTrackMagnetic

Units:rad(Radian)


/aircraft/<RegExp>/navigation/courseRhumbline/activeRoute


120


/aircraft/<RegExp>/navigation/courseRhumbline/activeRoute/href


/aircraft/<RegExp>/navigation/courseRhumbline/activeRoute/estimatedTimeOfArrival


/aircraft/<RegExp>/navigation/courseRhumbline/activeRoute/startTime


/aircraft/<RegExp>/navigation/courseRhumbline/nextPoint


/aircraft/<RegExp>/navigation/courseRhumbline/previousPoint



typehref

/aircraft/<RegExp>/navigation/courseRhumbline/previousPoint/distance

Units:m(Meter)


/aircraft/<RegExp>/navigation/courseRhumbline/previousPoint/position

Title:position





121

/aircraft/<RegExp>/navigation/courseGreatCircle

Title:Course


/aircraft/<RegExp>/navigation/courseGreatCircle/crossTrackError

Units:m(Meter)


/aircraft/<RegExp>/navigation/courseGreatCircle/bearingTrackTrue

Units:rad(Radian)


/aircraft/<RegExp>/navigation/courseGreatCircle/bearingTrackMagnetic

Units:rad(Radian)


/aircraft/<RegExp>/navigation/courseGreatCircle/activeRoute


/aircraft/<RegExp>/navigation/courseGreatCircle/activeRoute/href


/aircraft/<RegExp>/navigation/courseGreatCircle/activeRoute/estimatedTimeOfArrival


/aircraft/<RegExp>/navigation/courseGreatCircle/activeRoute/startTime


/aircraft/<RegExp>/navigation/courseGreatCircle/nextPoint


122


/aircraft/<RegExp>/navigation/courseGreatCircle/previousPoint



typehref

/aircraft/<RegExp>/navigation/courseGreatCircle/previousPoint/distance

Units:m(Meter)


/aircraft/<RegExp>/navigation/courseGreatCircle/previousPoint/position

Title:position




/aircraft/<RegExp>/navigation/closestApproach




/aircraft/<RegExp>/navigation/racing


/aircraft/<RegExp>/navigation/racing/startLineStb

Title:position




123


/aircraft/<RegExp>/navigation/racing/startLinePort

Title:position




/aircraft/<RegExp>/navigation/racing/distanceStartline

Units:m(Meter)


/aircraft/<RegExp>/navigation/racing/timeToStart

Units:s(Second)


/aircraft/<RegExp>/navigation/racing/timePortDown

Units:s(Second)


/aircraft/<RegExp>/navigation/racing/timePortUp

Units:s(Second)


/aircraft/<RegExp>/navigation/racing/timeStbdDown

Units:s(Second)


/aircraft/<RegExp>/navigation/racing/timeStbdUp


124

Units:s(Second)


/aircraft/<RegExp>/navigation/racing/distanceLayline

Units:m(Meter)


/aircraft/<RegExp>/navigation/magneticVariation

Units:rad(Radian)


/aircraft/<RegExp>/navigation/magneticVariationAgeOfService

Units:s(Second)


/aircraft/<RegExp>/navigation/destination

Title:destination


/aircraft/<RegExp>/navigation/destination/commonName


/aircraft/<RegExp>/navigation/destination/eta


/aircraft/<RegExp>/navigation/destination/waypoint


/aircraft/<RegExp>/navigation/gnss

Title:gnss


125


/aircraft/<RegExp>/navigation/gnss/type

Description:Fixtype

/aircraft/<RegExp>/navigation/gnss/methodQuality


/aircraft/<RegExp>/navigation/gnss/integrity


/aircraft/<RegExp>/navigation/gnss/satellites


/aircraft/<RegExp>/navigation/gnss/antennaAltitude

Units:m(Meter)


/aircraft/<RegExp>/navigation/gnss/horizontalDilution


/aircraft/<RegExp>/navigation/gnss/positionDilution


/aircraft/<RegExp>/navigation/gnss/geoidalSeparation


/aircraft/<RegExp>/navigation/gnss/differentialAge

Units:s(Second)



126

/aircraft/<RegExp>/navigation/gnss/differentialReference


/aircraft/<RegExp>/navigation/headingMagnetic

Units:rad(Radian)


/aircraft/<RegExp>/navigation/headingTrue

Units:rad(Radian)


/aircraft/<RegExp>/navigation/position

Title:position




/aircraft/<RegExp>/navigation/attitude

Title:Attitude




/aircraft/<RegExp>/navigation/maneuver


/aircraft/<RegExp>/navigation/rateOfTurn



127


/aircraft/<RegExp>/navigation/speedOverGround



/aircraft/<RegExp>/navigation/speedThroughWater



/aircraft/<RegExp>/navigation/speedThroughWaterTransverse



/aircraft/<RegExp>/navigation/speedThroughWaterLongitudinal



/aircraft/<RegExp>/navigation/leewayAngle

Units:rad(Radian)


/aircraft/<RegExp>/navigation/log

Units:m(Meter)


/aircraft/<RegExp>/navigation/trip


/aircraft/<RegExp>/navigation/trip/log


128

Units:m(Meter)


/aircraft/<RegExp>/navigation/trip/lastReset


/aircraft/<RegExp>/navigation/state

Title:state


/aircraft/<RegExp>/navigation/anchor

Title:anchor


/aircraft/<RegExp>/navigation/anchor/maxRadius

Units:m(Meter)


/aircraft/<RegExp>/navigation/anchor/currentRadius

Units:m(Meter)


/aircraft/<RegExp>/navigation/anchor/position

Title:position




/aircraft/<RegExp>/navigation/datetime



129

Fields:



/aircraft/<RegExp>/notifications

Title:notifications


/aircraft/<RegExp>/notifications/<RegExp>


/aircraft/<RegExp>/design

Title:design

Description:Design/dimensionaldataofthisaircraft

/aircraft/<RegExp>/design/displacement

Units:kg(Kilogram)


/aircraft/<RegExp>/design/aisShipType



idname

/aircraft/<RegExp>/design/draft

Title:draft


130





/aircraft/<RegExp>/design/length

Title:length




/aircraft/<RegExp>/design/keel

Title:keel


Fields:


longfinflarebulbwingcenterboardkantingliftingdaggerboard

/aircraft/<RegExp>/design/keel/angle

Units:rad(Radian)


/aircraft/<RegExp>/design/keel/lift

Units:ratio(Ratio)


131


/aircraft/<RegExp>/design/beam

Units:m(Meter)


/aircraft/<RegExp>/design/airHeight

Units:m(Meter)


/aircraft/<RegExp>/design/rigging

Title:rigging


Fields:


/aircraft/<RegExp>/sensors

Title:sensors


/aircraft/<RegExp>/sensors/<RegExp>

Title:sensor


/aircraft/<RegExp>/sensors/<RegExp>/name


/aircraft/<RegExp>/sensors/<RegExp>/sensorType



132

/aircraft/<RegExp>/sensors/<RegExp>/sensorData


/aircraft/<RegExp>/sensors/<RegExp>/fromBow


/aircraft/<RegExp>/sensors/<RegExp>/fromCenter


/aton

Description:AwrapperobjectforAidstoNavigation(aton's)

/aton/<RegExp>

Title:aidtonavigation

Description:ThisregexpatternisusedforvalidationofanMMSIorSignalKUUIDidentifierfortheaidtonavigation.Examples:urn:mrn:imo:mmsi:991099999urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d

/aton/<RegExp>/url

Description:URLbasedidentityoftheaidtonavigation,ifavailable.

/aton/<RegExp>/mmsi

Description:MMSInumberoftheaidtonavigation,ifavailable.

/aton/<RegExp>/uuid


/aton/<RegExp>/atonType

Description:Theatontype


idname


133

/aton/<RegExp>/name

Description:Theatonname

/aton/<RegExp>/communication

Title:communication


/aton/<RegExp>/communication/callsignVhf


/aton/<RegExp>/communication/callsignHf


/aton/<RegExp>/communication/phoneNumber


/aton/<RegExp>/communication/emailHf


/aton/<RegExp>/communication/email


/aton/<RegExp>/communication/satPhoneNumber


/aton/<RegExp>/communication/skipperName


/aton/<RegExp>/communication/crewNames



134

/aton/<RegExp>/environment

Title:environment


/aton/<RegExp>/environment/outside


/aton/<RegExp>/environment/outside/temperature

Units:K(Kelvin)


/aton/<RegExp>/environment/outside/dewPointTemperature

Units:K(Kelvin)


/aton/<RegExp>/environment/outside/apparentWindChillTemperature

Units:K(Kelvin)


/aton/<RegExp>/environment/outside/theoreticalWindChillTemperature

Units:K(Kelvin)


/aton/<RegExp>/environment/outside/heatIndexTemperature

Units:K(Kelvin)


/aton/<RegExp>/environment/outside/pressure

Units:Pa(Pascal)



135

/aton/<RegExp>/environment/outside/humidity

Units:ratio(Ratio)


/aton/<RegExp>/environment/outside/airDensity



/aton/<RegExp>/environment/outside/illuminance



/aton/<RegExp>/environment/inside


/aton/<RegExp>/environment/inside/temperature

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/humidity

Units:ratio(Ratio)


/aton/<RegExp>/environment/inside/engineRoom


/aton/<RegExp>/environment/inside/engineRoom/temperature

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/engineRoom/pressure


136

Units:Pa(Pascal)


/aton/<RegExp>/environment/inside/engineRoom/relativeHumidity

Units:ratio(Ratio)


/aton/<RegExp>/environment/inside/engineRoom/dewPoint

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/engineRoom/airDensity



/aton/<RegExp>/environment/inside/engineRoom/illuminance



/aton/<RegExp>/environment/inside/mainCabin


/aton/<RegExp>/environment/inside/mainCabin/temperature

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/mainCabin/pressure

Units:Pa(Pascal)


/aton/<RegExp>/environment/inside/mainCabin/relativeHumidity


137

Units:ratio(Ratio)


/aton/<RegExp>/environment/inside/mainCabin/dewPoint

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/mainCabin/airDensity



/aton/<RegExp>/environment/inside/mainCabin/illuminance



/aton/<RegExp>/environment/inside/refrigerator


/aton/<RegExp>/environment/inside/refrigerator/temperature

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/refrigerator/pressure

Units:Pa(Pascal)


/aton/<RegExp>/environment/inside/refrigerator/relativeHumidity

Units:ratio(Ratio)


/aton/<RegExp>/environment/inside/refrigerator/dewPoint


138

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/refrigerator/airDensity



/aton/<RegExp>/environment/inside/refrigerator/illuminance



/aton/<RegExp>/environment/inside/freezer


/aton/<RegExp>/environment/inside/freezer/temperature

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/freezer/pressure

Units:Pa(Pascal)


/aton/<RegExp>/environment/inside/freezer/relativeHumidity

Units:ratio(Ratio)


/aton/<RegExp>/environment/inside/freezer/dewPoint

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/freezer/airDensity


139



/aton/<RegExp>/environment/inside/freezer/illuminance



/aton/<RegExp>/environment/inside/heating


/aton/<RegExp>/environment/inside/heating/temperature

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/heating/pressure

Units:Pa(Pascal)


/aton/<RegExp>/environment/inside/heating/relativeHumidity

Units:ratio(Ratio)


/aton/<RegExp>/environment/inside/heating/dewPoint

Units:K(Kelvin)


/aton/<RegExp>/environment/inside/heating/airDensity



/aton/<RegExp>/environment/inside/heating/illuminance


140



/aton/<RegExp>/environment/water


/aton/<RegExp>/environment/water/temperature

Units:K(Kelvin)


/aton/<RegExp>/environment/water/salinity

Units:ratio(Ratio)


/aton/<RegExp>/environment/depth

Title:depth


/aton/<RegExp>/environment/depth/belowKeel

Units:m(Meter)


/aton/<RegExp>/environment/depth/belowTransducer

Units:m(Meter)


/aton/<RegExp>/environment/depth/belowSurface

Units:m(Meter)


/aton/<RegExp>/environment/depth/transducerToKeel


141

Units:m(Meter)


/aton/<RegExp>/environment/depth/surfaceToTransducer

Units:m(Meter)


/aton/<RegExp>/environment/current

Title:current




/aton/<RegExp>/environment/tide

Title:tide


/aton/<RegExp>/environment/tide/heightHigh

Units:m(Meter)


/aton/<RegExp>/environment/tide/heightNow

Units:m(Meter)


/aton/<RegExp>/environment/tide/heightLow

Units:m(Meter)


/aton/<RegExp>/environment/tide/timeLow


142



/aton/<RegExp>/environment/tide/timeHigh



/aton/<RegExp>/environment/heave

Units:m(Meter)


/aton/<RegExp>/environment/wind

Title:wind


/aton/<RegExp>/environment/wind/angleApparent

Units:rad(Radian)


/aton/<RegExp>/environment/wind/angleTrueGround

Units:rad(Radian)


/aton/<RegExp>/environment/wind/angleTrueWater

Units:rad(Radian)


/aton/<RegExp>/environment/wind/directionChangeAlarm

Units:rad(Radian)



143

/aton/<RegExp>/environment/wind/directionTrue

Units:rad(Radian)


/aton/<RegExp>/environment/wind/directionMagnetic

Units:rad(Radian)


/aton/<RegExp>/environment/wind/speedTrue



/aton/<RegExp>/environment/wind/speedOverGround



/aton/<RegExp>/environment/wind/speedApparent



/aton/<RegExp>/environment/time


Fields:


/aton/<RegExp>/environment/mode



144

/aton/<RegExp>/navigation

Title:navigation


/aton/<RegExp>/navigation/lights



/aton/<RegExp>/navigation/courseOverGroundMagnetic

Units:rad(Radian)


/aton/<RegExp>/navigation/courseOverGroundTrue

Units:rad(Radian)


/aton/<RegExp>/navigation/courseRhumbline

Title:Course


/aton/<RegExp>/navigation/courseRhumbline/crossTrackError

Units:m(Meter)


/aton/<RegExp>/navigation/courseRhumbline/bearingTrackTrue

Units:rad(Radian)


/aton/<RegExp>/navigation/courseRhumbline/bearingTrackMagnetic

Units:rad(Radian)


145


/aton/<RegExp>/navigation/courseRhumbline/activeRoute


/aton/<RegExp>/navigation/courseRhumbline/activeRoute/href


/aton/<RegExp>/navigation/courseRhumbline/activeRoute/estimatedTimeOfArrival


/aton/<RegExp>/navigation/courseRhumbline/activeRoute/startTime


/aton/<RegExp>/navigation/courseRhumbline/nextPoint


/aton/<RegExp>/navigation/courseRhumbline/previousPoint



typehref

/aton/<RegExp>/navigation/courseRhumbline/previousPoint/distance

Units:m(Meter)


/aton/<RegExp>/navigation/courseRhumbline/previousPoint/position

Title:position




146


/aton/<RegExp>/navigation/courseGreatCircle

Title:Course


/aton/<RegExp>/navigation/courseGreatCircle/crossTrackError

Units:m(Meter)


/aton/<RegExp>/navigation/courseGreatCircle/bearingTrackTrue

Units:rad(Radian)


/aton/<RegExp>/navigation/courseGreatCircle/bearingTrackMagnetic

Units:rad(Radian)


/aton/<RegExp>/navigation/courseGreatCircle/activeRoute


/aton/<RegExp>/navigation/courseGreatCircle/activeRoute/href


/aton/<RegExp>/navigation/courseGreatCircle/activeRoute/estimatedTimeOfArrival


/aton/<RegExp>/navigation/courseGreatCircle/activeRoute/startTime


147


/aton/<RegExp>/navigation/courseGreatCircle/nextPoint


/aton/<RegExp>/navigation/courseGreatCircle/previousPoint



typehref

/aton/<RegExp>/navigation/courseGreatCircle/previousPoint/distance

Units:m(Meter)


/aton/<RegExp>/navigation/courseGreatCircle/previousPoint/position

Title:position




/aton/<RegExp>/navigation/closestApproach




/aton/<RegExp>/navigation/racing


/aton/<RegExp>/navigation/racing/startLineStb


148

Title:position




/aton/<RegExp>/navigation/racing/startLinePort

Title:position




/aton/<RegExp>/navigation/racing/distanceStartline

Units:m(Meter)


/aton/<RegExp>/navigation/racing/timeToStart

Units:s(Second)


/aton/<RegExp>/navigation/racing/timePortDown

Units:s(Second)


/aton/<RegExp>/navigation/racing/timePortUp

Units:s(Second)


/aton/<RegExp>/navigation/racing/timeStbdDown

Units:s(Second)


149


/aton/<RegExp>/navigation/racing/timeStbdUp

Units:s(Second)


/aton/<RegExp>/navigation/racing/distanceLayline

Units:m(Meter)


/aton/<RegExp>/navigation/magneticVariation

Units:rad(Radian)


/aton/<RegExp>/navigation/magneticVariationAgeOfService

Units:s(Second)


/aton/<RegExp>/navigation/destination

Title:destination


/aton/<RegExp>/navigation/destination/commonName


/aton/<RegExp>/navigation/destination/eta


/aton/<RegExp>/navigation/destination/waypoint



150

/aton/<RegExp>/navigation/gnss

Title:gnss


/aton/<RegExp>/navigation/gnss/type

Description:Fixtype

/aton/<RegExp>/navigation/gnss/methodQuality


/aton/<RegExp>/navigation/gnss/integrity


/aton/<RegExp>/navigation/gnss/satellites


/aton/<RegExp>/navigation/gnss/antennaAltitude

Units:m(Meter)


/aton/<RegExp>/navigation/gnss/horizontalDilution


/aton/<RegExp>/navigation/gnss/positionDilution


/aton/<RegExp>/navigation/gnss/geoidalSeparation


/aton/<RegExp>/navigation/gnss/differentialAge


151

Units:s(Second)


/aton/<RegExp>/navigation/gnss/differentialReference


/aton/<RegExp>/navigation/headingMagnetic

Units:rad(Radian)


/aton/<RegExp>/navigation/headingTrue

Units:rad(Radian)


/aton/<RegExp>/navigation/position

Title:position




/aton/<RegExp>/navigation/attitude

Title:Attitude




/aton/<RegExp>/navigation/maneuver



152

/aton/<RegExp>/navigation/rateOfTurn



/aton/<RegExp>/navigation/speedOverGround



/aton/<RegExp>/navigation/speedThroughWater



/aton/<RegExp>/navigation/speedThroughWaterTransverse



/aton/<RegExp>/navigation/speedThroughWaterLongitudinal



/aton/<RegExp>/navigation/leewayAngle

Units:rad(Radian)


/aton/<RegExp>/navigation/log

Units:m(Meter)


/aton/<RegExp>/navigation/trip



153

/aton/<RegExp>/navigation/trip/log

Units:m(Meter)


/aton/<RegExp>/navigation/trip/lastReset


/aton/<RegExp>/navigation/state

Title:state


/aton/<RegExp>/navigation/anchor

Title:anchor


/aton/<RegExp>/navigation/anchor/maxRadius

Units:m(Meter)


/aton/<RegExp>/navigation/anchor/currentRadius

Units:m(Meter)


/aton/<RegExp>/navigation/anchor/position

Title:position





154

/aton/<RegExp>/navigation/datetime


Fields:



/aton/<RegExp>/notifications

Title:notifications


/aton/<RegExp>/notifications/<RegExp>


/aton/<RegExp>/design

Title:design

Description:Design/dimensionaldataofthis

/aton/<RegExp>/design/displacement

Units:kg(Kilogram)


/aton/<RegExp>/design/aisShipType



idname


155


/aton/<RegExp>/design/draft

Title:draft




/aton/<RegExp>/design/length

Title:length




/aton/<RegExp>/design/keel

Title:keel


Fields:


longfinflarebulbwingcenterboardkantingliftingdaggerboard

/aton/<RegExp>/design/keel/angle

Units:rad(Radian)


/aton/<RegExp>/design/keel/lift


156

Units:ratio(Ratio)


/aton/<RegExp>/design/beam

Units:m(Meter)


/aton/<RegExp>/design/airHeight

Units:m(Meter)


/aton/<RegExp>/design/rigging

Title:rigging


Fields:


/aton/<RegExp>/sensors

Title:sensors


/aton/<RegExp>/sensors/<RegExp>

Title:sensor


/aton/<RegExp>/sensors/<RegExp>/name


/aton/<RegExp>/sensors/<RegExp>/sensorType



157

/aton/<RegExp>/sensors/<RegExp>/sensorData


/aton/<RegExp>/sensors/<RegExp>/fromBow


/aton/<RegExp>/sensors/<RegExp>/fromCenter


/sar

Description:AwrapperobjectforSearchAndRescue(SAR)MMSI'susiedintransponders.MOB,EPIRBSetc

/sar/<RegExp>

Title:Searchandrescuebeacons

Description:ThisregexpatternisusedforvalidationofanMMSIorSignalKUUIDidentifierfortheaidtonavigation.Examples:urn:mrn:imo:mmsi:972099999urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d

/sar/<RegExp>/url

Description:URLbasedidentityoftheaidtonavigation,ifavailable.

/sar/<RegExp>/mmsi

Description:MMSInumberoftheaidtonavigation,ifavailable.

/sar/<RegExp>/uuid


/sar/<RegExp>/communication

Title:communication



158

/sar/<RegExp>/communication/callsignVhf


/sar/<RegExp>/communication/callsignHf


/sar/<RegExp>/communication/phoneNumber


/sar/<RegExp>/communication/emailHf


/sar/<RegExp>/communication/email


/sar/<RegExp>/communication/satPhoneNumber


/sar/<RegExp>/communication/skipperName


/sar/<RegExp>/communication/crewNames


/sar/<RegExp>/navigation

Title:navigation


/sar/<RegExp>/navigation/lights



159


/sar/<RegExp>/navigation/courseOverGroundMagnetic

Units:rad(Radian)


/sar/<RegExp>/navigation/courseOverGroundTrue

Units:rad(Radian)


/sar/<RegExp>/navigation/courseRhumbline

Title:Course


/sar/<RegExp>/navigation/courseRhumbline/crossTrackError

Units:m(Meter)


/sar/<RegExp>/navigation/courseRhumbline/bearingTrackTrue

Units:rad(Radian)


/sar/<RegExp>/navigation/courseRhumbline/bearingTrackMagnetic

Units:rad(Radian)


/sar/<RegExp>/navigation/courseRhumbline/activeRoute


/sar/<RegExp>/navigation/courseRhumbline/activeRoute/href


160


/sar/<RegExp>/navigation/courseRhumbline/activeRoute/estimatedTimeOfArrival


/sar/<RegExp>/navigation/courseRhumbline/activeRoute/startTime


/sar/<RegExp>/navigation/courseRhumbline/nextPoint


/sar/<RegExp>/navigation/courseRhumbline/previousPoint



typehref

/sar/<RegExp>/navigation/courseRhumbline/previousPoint/distance

Units:m(Meter)


/sar/<RegExp>/navigation/courseRhumbline/previousPoint/position

Title:position




/sar/<RegExp>/navigation/courseGreatCircle

Title:Course



161

/sar/<RegExp>/navigation/courseGreatCircle/crossTrackError

Units:m(Meter)


/sar/<RegExp>/navigation/courseGreatCircle/bearingTrackTrue

Units:rad(Radian)


/sar/<RegExp>/navigation/courseGreatCircle/bearingTrackMagnetic

Units:rad(Radian)


/sar/<RegExp>/navigation/courseGreatCircle/activeRoute


/sar/<RegExp>/navigation/courseGreatCircle/activeRoute/href


/sar/<RegExp>/navigation/courseGreatCircle/activeRoute/estimatedTimeOfArrival


/sar/<RegExp>/navigation/courseGreatCircle/activeRoute/startTime


/sar/<RegExp>/navigation/courseGreatCircle/nextPoint


/sar/<RegExp>/navigation/courseGreatCircle/previousPoint



162


typehref

/sar/<RegExp>/navigation/courseGreatCircle/previousPoint/distance

Units:m(Meter)


/sar/<RegExp>/navigation/courseGreatCircle/previousPoint/position

Title:position




/sar/<RegExp>/navigation/closestApproach




/sar/<RegExp>/navigation/racing


/sar/<RegExp>/navigation/racing/startLineStb

Title:position




/sar/<RegExp>/navigation/racing/startLinePort


163

Title:position




/sar/<RegExp>/navigation/racing/distanceStartline

Units:m(Meter)


/sar/<RegExp>/navigation/racing/timeToStart

Units:s(Second)


/sar/<RegExp>/navigation/racing/timePortDown

Units:s(Second)


/sar/<RegExp>/navigation/racing/timePortUp

Units:s(Second)


/sar/<RegExp>/navigation/racing/timeStbdDown

Units:s(Second)


/sar/<RegExp>/navigation/racing/timeStbdUp

Units:s(Second)


/sar/<RegExp>/navigation/racing/distanceLayline


164

Units:m(Meter)


/sar/<RegExp>/navigation/magneticVariation

Units:rad(Radian)


/sar/<RegExp>/navigation/magneticVariationAgeOfService

Units:s(Second)


/sar/<RegExp>/navigation/destination

Title:destination


/sar/<RegExp>/navigation/destination/commonName


/sar/<RegExp>/navigation/destination/eta


/sar/<RegExp>/navigation/destination/waypoint


/sar/<RegExp>/navigation/gnss

Title:gnss


/sar/<RegExp>/navigation/gnss/type

Description:Fixtype


165

/sar/<RegExp>/navigation/gnss/methodQuality


/sar/<RegExp>/navigation/gnss/integrity


/sar/<RegExp>/navigation/gnss/satellites


/sar/<RegExp>/navigation/gnss/antennaAltitude

Units:m(Meter)


/sar/<RegExp>/navigation/gnss/horizontalDilution


/sar/<RegExp>/navigation/gnss/positionDilution


/sar/<RegExp>/navigation/gnss/geoidalSeparation


/sar/<RegExp>/navigation/gnss/differentialAge

Units:s(Second)


/sar/<RegExp>/navigation/gnss/differentialReference


/sar/<RegExp>/navigation/headingMagnetic


166

Units:rad(Radian)


/sar/<RegExp>/navigation/headingTrue

Units:rad(Radian)


/sar/<RegExp>/navigation/position

Title:position




/sar/<RegExp>/navigation/attitude

Title:Attitude




/sar/<RegExp>/navigation/maneuver


/sar/<RegExp>/navigation/rateOfTurn



/sar/<RegExp>/navigation/speedOverGround



167


/sar/<RegExp>/navigation/speedThroughWater



/sar/<RegExp>/navigation/speedThroughWaterTransverse



/sar/<RegExp>/navigation/speedThroughWaterLongitudinal



/sar/<RegExp>/navigation/leewayAngle

Units:rad(Radian)


/sar/<RegExp>/navigation/log

Units:m(Meter)


/sar/<RegExp>/navigation/trip


/sar/<RegExp>/navigation/trip/log

Units:m(Meter)


/sar/<RegExp>/navigation/trip/lastReset


168


/sar/<RegExp>/navigation/state

Title:state


/sar/<RegExp>/navigation/anchor

Title:anchor


/sar/<RegExp>/navigation/anchor/maxRadius

Units:m(Meter)


/sar/<RegExp>/navigation/anchor/currentRadius

Units:m(Meter)


/sar/<RegExp>/navigation/anchor/position

Title:position




/sar/<RegExp>/navigation/datetime


Fields:


GPSGLONASSGalileo


169

BeidouIRNSSRadioSignalInternetLocalclock

/sar/<RegExp>/notifications

Title:notifications


/sar/<RegExp>/notifications/mob

Description:Manoverboard


methodstatemessage

/sar/<RegExp>/notifications/fire

Description:Fireonboard


methodstatemessage

/sar/<RegExp>/notifications/sinking

Description:Vesselissinking


methodstatemessage

/sar/<RegExp>/notifications/flooding

Description:Vesselisflooding


method


170

statemessage

/sar/<RegExp>/notifications/collision

Description:Incollisionwithanothervesselorobject


methodstatemessage

/sar/<RegExp>/notifications/grounding

Description:Vesselgrounding


methodstatemessage

/sar/<RegExp>/notifications/listing

Description:Vesselislisting


methodstatemessage

/sar/<RegExp>/notifications/adrift

Description:Vesselisadrift


methodstatemessage

/sar/<RegExp>/notifications/piracy

Description:Underattackordangerfrompirates


method


171

statemessage

/sar/<RegExp>/notifications/abandon

Description:Abandonship


methodstatemessage

/sar/<RegExp>/notifications/<RegExp>


/resources

Title:resources

Description:Resourcestoaidinnavigationandoperationofthevesselincludingwaypoints,routes,notes,etc.

/resources/charts

Title:chart

Description:Aholderforcharts,eachnamedwiththeirchartcode

/resources/charts/<RegExp>

Description:Achart

Fields:

name(Chartcommonname)identifier(Chartnumber)description(Adescriptionofthechart)tilemapUrl(AurltothetilemapofthechartforuseinTMSchartplottingapps)region(Regionrelatedtonote.ApointertoaregionUUID.Alternativetogeohash)geohash(Positionrelatedtochart.Alternativetoregion)chartUrl(Aurltothechartfile'sstoragelocation)scale(Thescaleofthechart,thelargernumberfrom1:200000)chartLayers(IfthechartformatisWMS,thelayersenabledforthechart.)bounds(Theboundsofthechart.Anarraycontainingthepositionoftheupperleftcorner,andthelowerrightcorner.Usefulwhenthechartisn'tinherentlygeo-referenced.)chartFormat(Theformatofthechart),enum:

gif


172

geotiffkappngjpgkmlwkttopojsongeojsongpxtmswmsS-57S-63svgother

/resources/routes

Title:route

Description:Aholderforroutes,eachnamedwithaUUID

/resources/routes/<RegExp>

Description:Aroute,namedwithaUUID

Fields:

name(Route'scommonname)description(Adescriptionoftheroute)distance(Totaldistancefromstarttoend),units:m(Meter)start(ThewaypointUUIDatthestartoftheroute)end(ThewaypointUUIDattheendoftheroute)feature(AGeoJSONfeatureobjectwhichdescribestheroutebetweenthewaypoints)

type,enum:

Featuregeometry

type,enum:

LineStringcoordinates(Anarrayoftwoormorepositions)

properties(Additionaldataofanytype)id

/resources/notes

Title:notes


173

Description:Aholderfornotesaboutregions,eachnamedwithaUUID.Notesmightincludenavigationorcruisinginfo,images,oranything

/resources/notes/<RegExp>

Description:Anoteaboutaregion,namedwithaUUID.Notesmightincludenavigationorcruisinginfo,images,oranything

Fields:

title(Note'scommonname)description(Atextualdescriptionofthenote)region(Regionrelatedtonote.ApointertoaregionUUID.Alternativetopositionorgeohash)geohash(Positionrelatedtonote.Alternativetoregionorposition)mimeType(MIMEtypeofthenote)url(Locationofthenote)

/resources/notes/<RegExp>/position

Title:position

Description:Positionrelatedtonote.Alternativetoregionorgeohash



/resources/regions

Title:region

Description:Aholderforregions,eachnamedwithUUID

/resources/regions/<RegExp>

Description:Aregionofinterest,eachnamedwithaUUID

Fields:

geohash(geohashoftheapproximateboundaryofthisregion)feature(AGeoJSONfeatureobjectwhichdescribestheregionsboundary)

type,enum:

Featuregeometry

properties(Additionaldataofanytype)id


174

/resources/waypoints

Title:waypoints

Description:Aholderforwaypoints,eachnamedwithaUUID

/resources/waypoints/<RegExp>

Description:Awaypoint,namedwithaUUID

/resources/waypoints/<RegExp>/position

Title:position

Description:Thepositionin3dimensions



/resources/waypoints/<RegExp>/feature

Title:Feature

Description:AGeoJSONfeatureobject

/resources/waypoints/<RegExp>/feature/type


Enumvalues:

Feature

/resources/waypoints/<RegExp>/feature/geometry

Title:Point


/resources/waypoints/<RegExp>/feature/geometry/type


Enumvalues:

Point


175

/resources/waypoints/<RegExp>/feature/geometry/coordinates

Description:Asingleposition,inx,yorder(Lon,Lat)

/resources/waypoints/<RegExp>/feature/properties

Description:Additionaldataofanytype

/resources/waypoints/<RegExp>/feature/id


/version

Description:VersionoftheschemaandAPIsthatthisdataisusinginCanonicalformati.e.V1.0.0.


176

ChangeLog

v1.0.4(2018/04/2212:55+00:00)

#432AddDocumentationforSources(@timmathews)#458Putdescriptivesourcepropertieswheretheybelong(@timmathews)#451WIP:docs:addnotescoveringnamingconventionsforpullrequests(@bkp7)#449Removedspacesfromfilenames.(@bkp7)#433Convertdocstouseverifiedjsonsamples(@bkp7)#448ModifydescriptionofMagneticVariation(@bkp7)#438fix:invalidelectricalschema(@bkp7)#419fix:modifypackage.jsontomakeitcrossplatformcompatible.(@bkp7)#422refactor:improveusabilityofjsonvalidationtests(@bkp7)#429chore:usenodeltsversion(@tkurki)#424polish:improvementstodocumentation:versioning.md(@bkp7)#421UpdateTravisteststouselatestnode-jsv8.x.xrelease(@bkp7)#415Additionalunitswithcorrections(@bkp7)#414Addthesamplestotestscripts(@bkp7)

v1.0.3(2018/01/0819:40+00:00)

#416fix:makeselfrelativetorootinfull(@tkurki)#413Fixed:buginmessagestests(@bkp7)#412fixnpminstallfailingonwindowsplatforms(@bkp7)

v1.0.0(2018/01/0108:58+00:00)

#396Rootrelativeself(@tkurki)#358Documentationandschemafixes(@rob42)#403Fixtypoinconnection.md(@gilesvangruisen)

v0.0.1-12(2017/11/0419:48+00:00)

#315Objectvaluedpropertiesundervalueinfullmodel(@tkurki)#395feature:specifyWGS84forcoordinates(@tkurki)#392spec:removesparseformat(@tkurki)#393feature:specifyWGS84forcoordinates(@tkurki)#372Improve,removelogicerrorinpropslipdescription(@joabakk)#366AddCPAandTCPA(@joabakk)#390feature:Addserverinformationtodiscovery(@tkurki)#385Feature:make/selfrequired(@tkurki)

v0.0.1-11(2017/10/1718:46+00:00)

#388feature:addschemaapitogetshipandatontypenamesfromtheid(@sbender9)#386fix:betteraisShipTypeandatonType(@sbender9)

v0.0.1-9(2017/10/0714:29+00:00)

#383fix:don'tcreateundefinedmetaproperties(@tkurki)

AppendixC:Changelog

177

https://github.com/SignalK/specification/pull/432































v0.0.1-7(2017/09/2717:42+00:00)

#332feature:addmetadatahandlingtojslib(@tkurki)#382feature:includeenumsinkeyswithmetadata(@tkurki)#381Addoutsideairdensity(@joabakk)

v0.0.1-6(2017/08/0920:02+00:00)

#368TranspiledistributednpmmoduletoES2015(@tkurki)

v0.0.1-5(2017/08/0919:24+00:00)

#375AddAlternatorandSolardevices,createchargerQualitiies+cleanups(@thomasonw)

v0.0.1-4(2017/08/0917:16+00:00)

#374AddcommonValueFieldstonotifications(@sbender9)#369Minorfixes(@parsley72)#365AddintakeManifoldTemperaturetopropulsionschema(@anajavi)#364Changefromschemas/versiontoversion/schemas(@rob42)#361Fixdescriptiontyposinperformance(@joabakk)#355[WIP]Convertjsonidfromhttps://signalk.github.io/specification/schemas…(@rob42)#357Splitgitbookdockeyslist(@tkurki)#353Fixedtyposandtextformatting(@aplathan)#342Rewritemultiplesources/valuesdocumentation(@tkurki)

v0.0.1-3(2017/04/1904:41+00:00)

#350AddpagespecifyingversioninginSignalK(@rob42)#337Aisadditions(@rob42)#351Addnoteondataaccuracy(@rob42)#349fix:fixdollarsourcereferencesinfulltree(@tkurki)#347Multiplevaluesubscriptionsdocumentation(@tkurki)#344AddedSARaircraft,updatesteststohandleaircraft,addvessel.mmsi…(@rob42)#346Tanks(@rob42)

v0.0.1-1(2017/03/1916:07+00:00)

#348Addnotethatmeta.unitsMUSTbereturnedforvalidkeys(@rob42)#345Addedtrip.log,andtrip.lastReset(@rob42)#340Addslackbadge(@bkp7)#336Patternforversion(@bkp7)#328AddedtimezoneRegiontoenvironment.time(@bkp7)#321Fixnotificationsschema(@bkp7)#335Addedilluminance(@rob42)#325Improvementstothechartmodel(@emilecantin)#319Addchangeloggeneration(@tkurki)#327UpdatedSchemasothatdate-timemustbeinUTC(@bkp7)#324DefinetimestampasJSONSchemadate-time(@bkp7)#320Fixschemafilestobevalidagainsthttp://json-schema.org/draft-04/schema#(@bkp7)#299Generatedocumentationforobjecttypesfromlocalfiles(@joux3)#312Specifyvesselcontextandleafpathfordelta(@tkurki)

AppendixC:Changelog

178












https://signalk.github.io/specification/schemas…























http://json-schema.org/draft-04/schema



#313Itemizecourseproperties(@tkurki)

v0.0.1-0(2016/12/2719:54+00:00)

#309ImproveToplevelsignalkoverview(@sumps)#272Updatemultiplevaluesdocumentation(@tkurki)#301AddsupportfordollarpathinFullSignalK(@tkurki)#306RemovedrefererencetoBoundaryLayer(@sumps)#283AddTransverseWaterSpeedandLeewayAngle(@sumps)#300ExpandontheDiscoverySection(@timmathews)#290MakeprocessSchemaFilesproducekeyswithmetadata.json(@tkurki)#284Steeringgroupinlinewithautopilotcommunication(@joabakk)#278Validatemissingschemareferences&fixmissingreferences(@joux3)#270Usewildcardcontextinexample,mentionwildcard(@tkurki)#265AddChangelog(@tkurki)#274Resolverelativereferencesinthesamefile(@joux3)#269RFC0004:ReplaceJsonPathwithwildcardinsubscriptionpaths(@tkurki)#225Adddefaultsoverlay(@timmathews)#257Reorganizedsteeringgroup,addedtest(@joabakk)#266Cleanupofsourcesschema(@thomasonw)#260Clarifygitbook-docs/README.md(@timmathews)#261Cleanups(@thomasonw)#255GitbookDocumentationmvp(@tkurki)#245MaketankcapacitynumberValue(@tkurki)#238SourcehandlingforNMEAandnon-NMEAsources(@tkurki)#232Addedmissingmessagetypes(@rob42)#233Addedchartscale,andsomenewchartstypes(@rob42)#230Addedexamples,andtidieddescriptions(@rob42)#231adddescriptiontoenumvalues(@sailoog)#228Includeenumsinkeyswithmetadata.json(@tkurki)#221AddGC/RLdistinction(@tkurki)#223ConsistentUseofJSON-schemadraft04Format(@timmathews)#222TankSendersonlyprovidetanklevelvalue(@sumps)#211Alternativeproposalfor"course"objectinnavigation(@fabdrol)#217Reorganisetemperaturesabit(@tkurki)#202Addgeneral&n2kspecificinfotosources(@tkurki)#193Addedracingparameters(@joabakk)#204Renamedrefridgerationtorefrigerator(@joabakk)#201Fixkeyswithmetadata(@tkurki)#200AddedStateofHealthtoBatteries(@sumps)#185Reorganiseelectrical:removeac/dcdistinction,branchesforequipmenttypes(@tkurki)#186Temp,humidity,pressurereorganisation(@tkurki)#195Refactortanks(@tkurki)#194Unitcleanupandaddedpropslipdependancies(@tkurki)#190Improvedescriptions(@joabakk)#182ReplacemaxRevolutionswithzonesusage(@tkurki)#175Addedagnostictargetspeedandtargetangle(@joabakk)#176RemovelegacyAlarmobjectsfromEnvironmentTree(@sumps)#165Addengineload&torque(@tkurki)#118Multiplevalues(take2)(@tkurki)#161Convertzoneinmetatoanobject(@rob42)

AppendixC:Changelog

179

















































#162Renamealarmsbranchtonotifications(@rob42)#142Masterwaypointsref(@rob42)#160Removealarmuuidfrompathasitsnotneeded.(@rob42)#159Updatevessel.json(@joabakk)#152Improvealarms-addalertandemergency(@rob42)#120Improvepropulsion(@tkurki)#119Reworkelectricaldc:batteries(@tkurki)#151UseSPDXabbreviationofthelicense(@tkurki)#148Addschemaandtestsforendpointdiscovery(@jboynes)#149Removeunneededreferencestolodash(@jboynes)#145Addedregistrationstructure(@rob42)#139Addedlightstonavigation(@rob42)#143Addenv.mode-take2-Addsource/timestampandtest(@rob42)#141Addedenvironment.mode(@rob42)#140AddedIMO,flag,port,andregnumber(@rob42)#136AdddatetimewithsourceinformationtotheSignalKmodel(@tkurki)#137Masteraddsystime(@rob42)#132Expressairpressurechangerateasarate(@jboynes)#129ReplacelastuseoffloatValuewithnumberValue(@jboynes)#128RemovedCallsignDsc(@sumps)#121AddHeavetoenvironment.json(@sumps)#117AdditionalGNSSfieldadded(@sumps)#114Changeallunitsto(derived)SIunits(fixissue#30)(@keesverruijt)#113Implementmyownsuggestioninissue#112(@keesverruijt)#110Identities,taketwo(@fabdrol)#109AddNMEA0183sentenceandtalkertosource(@tkurki)#107Fixschemareferencesandaddallsubschemasforvalidation(@tkurki)#105Housekeeping:cleanupofallschemas(@fabdrol)#103Relocatecurrentfromnavigationtoenvironment(@timmathews)#101SplitangleTrue(@tkurki)#87Improvevalidation(@tkurki)#88Changepgntypetonumber(@tkurki)#81Formatthedesigngroup(@MariusVolkhart)#78Formatthepropulsiongroup(@MariusVolkhart)#79Formattheelectrical_dcgroup(@MariusVolkhart)#77Formattheresourcesgroup(@MariusVolkhart)#80Formatthenavigationgroup(@MariusVolkhart)#82Formatthealarmsgroup(@MariusVolkhart)#83AddedanUUIDpropertytovessel.json(@fabdrol)#75Formatallenumstothesamestyle(@MariusVolkhart)#70Formatvessel.json(@MariusVolkhart)#54PullofrestructuredELECTRICALJSONschema(@thomasonw)#52Electrical,AC(@timmathews)#64Messageschemas(@rob42)#51Grouprollpitchandyaw(@timmathews)#65Updatestothe"design"group,inordertoaccommodatevesselswithavariablekeelorcenterboardandsomeotherchanges(@fabdrol)#67Separategroupforsails(@fabdrol)#55LabelsforSignalKdataitems(@tkurki)#63Morelenientdeltaschema(@tkurki)#62Changesubschemaloading(@tkurki)

AppendixC:Changelog

180



















































#61Addedn2kMappings(@tkurki)#59Addedperformancegrouptovessel.json(@zapfware)#57DefinespecificationforPerformancedata(@zapfware)#58Addwaypoint.distanceActual,correctunitsforlog&logTrip(@zapfware)#50Fixpropulsionandsensorsandsomecleanup(@rob42)#44Reorganizecurrentgroup(@timmathews)#43AddssourceandtimestamptoactiveRoute(@timmathews)#42Renamenavigation.currentRoute(@timmathews)#34Updatelayout(@timmathews)#29Deltaschema&validation(@tkurki)#31StandardizeformattinginschemaJSONfiles(@timmathews)#27Changesrelatedton2kintegration(@tkurki)#26Movesource/timestampsoitonlyoccursonleafnodes(@rob42)#24Indentwith4spaces(@tkurki)#23Windangle&direction(@tkurki)#21Addedsensors,designdata,andanchordata(@rob42)#17AddeddefinitionforGNSSobject(@fabdrol)#15Resources-addheadersetc(@rob42)#14Trytoaddheaders(@rob42)#12Addsignalkheadertodocsunpage(@rob42)#11ReplaceexperimentalJavaScriptcalls(@timmathews)#9Resources(@rob42)#5Addedalarmsgroup(@rob42)#6Addedbasicprinciples(@rob42)#4Fixtodocson.js(@timmathews)#3Separatedschemas(@fabdrol)#1AddedinstructionsforpublishingspectoGHPages(@timmathews)

AppendixC:Changelog

181




























VersioninginSignalKspecificationOurversioningisbasedonhttp://snowplowanalytics.com/blog/2014/05/13/introducing-schemaver-for-semantic-versioning-of-schemas/

Mostofthisdocumentisreproducedfromthere.

Whenversioningadataschema,weareconcernedwiththebackwards-compatibilitybetweenthenewschemaandexistingdatarepresentedinearlierversionsoftheschema.ThisisthefundamentalbuildingblockofSchemaVer,andexplainsthedivergencefromSemanticVersioning.

HeresasimpleformulaforourSchemaVer:

GivenaversionnumberMODEL.REVISION.ADDITION-SUFFIX,incrementthe:

MODEL-whenyoumakeabreakingschemachangewhichwillpreventinteractionwithanyhistoricaldataREVISION-whenyoumakeaschemachangewhichmaypreventinteractionwithsomehistoricaldataADDITION-whenyoumakeaschemachangethatiscompatiblewithallhistoricaldataSUFFIX-optional-denotesspecialversionsoractivedevelopmentegalpha-1,SNAPSHOT

ThefirstreleasedversionofSignalKwillbe1.0.0.

Thecurrentdevelopmentversionwillthenmovetobe1.0.1-SNAPSHOTThenextreleasecandidatemightthenbe1.0.1-alpha-1Thecurrentdevelopmentversionwillthenmovetobe1.0.2-SNAPSHOT

SNAPSHOTdenotesaversionunderactivechange.IfyoudependontheSNAPSHOTversiontheneverytimeyoubuildyourprojectitwillhavechangedwithwhat-everwascommittedsincelasttimeyouchecked.

Let’smakeSchemaVermoreconcretewithsomeexamplesusingsome(truncatedandcontrived)SignalKSchemas,inreverseorder:

AdditionWehaveanexistingJSONSchema,let’scallthis1.0.0:

{

"type":"object",

"$schema":"http://json-schema.org/draft-04/schema#",

"id":"https://signalk.org/demospecification/1.0.0/schemas/groups/communication.json#",

"description":"Schemadescribingthecommunicationchild-objectofaVessel.",

"title":"communication",

"properties":{

"dscAddress":{

"type":"string",

"description":"MMSICallsignforVHFcommunication"

}

},

"required":["dscAddress"],

"additionalProperties":false

}

Nowwewanttoaddanadditionalfieldtoourschema:

{

"type":"object",



182

http://snowplowanalytics.com/blog/2014/05/13/introducing-schemaver-for-semantic-versioning-of-schemas/

http://semver.org/




"properties":{

"dscAddress":{

"type":"string",


},

"phoneNumber":{

"type":"string",

"description":"Phonenumberofskipper",

"example":"+64xxxxxx"

}

},



}

BecauseournewphoneNumberfieldisnotarequiredfield,andbecauseversion1.0.0hadadditionalPropertiessettofalse,weknowthatallhistoricaldatawillworkwiththisnewschema,ie.anyjsonwhichvalidatesagainst1.0.0willalsobevalidagainst1.0.1.

ThereforewearelookingatanADDITION,andsowebumptheschemaversionto1.0.1.

RevisionLet’snowmakeourJSONSchemasupportadditionalProperties-thisconstitutesanotherADDITION,sowearenowon1.0.2:

{

"type":"object",





"properties":{

"dscAddress":{

"type":"string",


},

"phoneNumber":{

"type":"string",



}

},


"additionalProperties":true

}

Afterawhile,weaddanewfield,callsignHf:

{

"type":"object",





"properties":{

"dscAddress":{

"type":"string",


},

"phoneNumber":{


183

"type":"string",



},

"callsignHf":{

"type":"string",

"description":"CallsignforHFcommunication",

"example":"ZL3RTH"

}

},


"additionalProperties":true

}

Willthisnewschemavalidateallhistoricaldata?Unfortunatelywecan’tbecertain,becausetherecouldbehistoricalJSONswheretheanalystaddedtheirowncallsignHffieldwhichwasnotastring.

SoweareeffectivelymakingaREVISIONtothedataschema-sowebumptheversionto1.1.0(resettingADDITIONto0).

ModelOhdear-wehavejustrealizedthatnotevery-onehasDSC!ItshouldhavebeenaVHFcallsign.HereisournewJSONSchema:

{

"type":"object",





"properties":{

"callsignVhf":{

"type":"string",

"description":"CallsignforVHFcommunication",

"example":"ZL1234"

},

"phoneNumber":{

"type":"string",



},

"callsignHf":{

"type":"string",

"description":"CallsignforHFcommunication",

"example":"ZL3RTH"

}

},

"required":["callsignVhf"],


}

WehavechangedourMODEL-becausewecanhavenoreasonableexpectationthatanyofthehistoricaldatacaninteractwiththisschema.Thatmeansournewversionis2.0.0

Notethatwealsodecidedtousethis“reboot”oftheMODELtochangeadditionalPropertiesbacktofalse,because(aswehavelearnt)itwillhelpustoavoidunnecessaryREVISIONsinthefuture.

Note:https://signalk.org/demospecification/...isnotreal,itisjustusedhereforillustration.Therealschemasarelocatedat:https://signalk.org/specification/...

Supplementaryrules


184

https://signalk.org/demospecification/

https://signalk.org/specification/

InSignalKwehaveafewvariationsfromSchemaVer:

Weusedots(.)toseparatetheversionparts,nothyphens(-s)asinSchemaVerWeuseasuffixtodenotein-progressorspecialreleases,ascommonlyseeninMaven


185

http://books.sonatype.com/mvnref-book/reference/pom-relationships-sect-pom-syntax.html

table of contents - signal ksignalk.org/specification/1.0.4/doc/signalk.pdf · position –...

Documents