/self

Description: This holds the key (UUID, MMSI or URL) of this vessel, the actual data is in the vessels array.


/aircraft

Description: A wrapper object for aircraft, primarily intended for SAR aircraft in relation to marine search and rescue. For clarity about seaplanes etc, if it CAN fly, its an aircraft.


/aircraft/<RegExp>

Title: aircraft

Description: This regex pattern is used for validation of an MMSI or Signal K UUID identifier for the aircraft. Examples: urn:mrn:imo:mmsi:111099999 urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d


/aircraft/<RegExp>/url

Description: URL based identity of the aircraft, if available.


/aircraft/<RegExp>/mmsi

Description: MMSI number of the aircraft, if available.


/aircraft/<RegExp>/uuid

Description: A unique Signal K flavoured maritime resource identifier, assigned by the server.


/aircraft/<RegExp>/flag

Description: The country of aircraft registration, or flag state of the aircraft


/aircraft/<RegExp>/base

Description: The home base of the aircraft


/aircraft/<RegExp>/registrations

Description: The various registrations of the aircraft.


/aircraft/<RegExp>/registrations/imo

Description: The IMO number of the aircraft.


/aircraft/<RegExp>/registrations/national

Description: The national registration number of the aircraft.


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

Description: This regex pattern is used for validating the identifier for the registration


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

Description: The ISO 3166-2 country code.


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

Description: The registration code


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

Description: The registration description


/aircraft/<RegExp>/registrations/other

Description: Other registration or permits for the aircraft.


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

Description: This regex pattern is used for validating the identifier for the registration


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

Description: The registration code


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

Description: The registration description


/aircraft/<RegExp>/communication

Title: communication

Description: Communication data including Radio, Telephone, E-Mail, etc.


/aircraft/<RegExp>/communication/callsignVhf

Description: Callsign for VHF communication


/aircraft/<RegExp>/communication/callsignHf

Description: Callsign for HF communication


/aircraft/<RegExp>/communication/phoneNumber

Description: Phone number of skipper


/aircraft/<RegExp>/communication/emailHf

Description: Email address to be used for HF email (Winmail, Airmail, Sailmail)


/aircraft/<RegExp>/communication/email

Description: Regular email for the skipper


/aircraft/<RegExp>/communication/satPhoneNumber

Description: Satellite phone number for vessel.


/aircraft/<RegExp>/communication/skipperName

Description: Full name of the skipper of the vessel.


/aircraft/<RegExp>/communication/crewNames

Description: Array with the names of the crew


/aircraft/<RegExp>/environment

Title: environment

Description: Environmental data measured locally including Depth, Wind, Temp, etc.


/aircraft/<RegExp>/environment/outside

Description: Environmental conditions outside of the vessel's hull


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

Units: K (Kelvin)

Description: Current outside air temperature


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

Units: K (Kelvin)

Description: Current outside dew point temperature


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

Units: K (Kelvin)

Description: Current outside apparent wind chill temperature


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

Units: K (Kelvin)

Description: Current outside theoretical wind chill temperature


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

Units: K (Kelvin)

Description: Current outside heat index temperature


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

Units: Pa (Pascal)

Description: Current outside air ambient pressure


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

Units: ratio (Ratio)

Description: Current outside air relative humidity


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

Units: Lux (undefined)

Description: Current outside ambient light flux.


/aircraft/<RegExp>/environment/inside

Description: Environmental conditions inside the vessel's hull


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

Units: K (Kelvin)

Description: Current inside air temperature


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

Units: ratio (Ratio)

Description: Current inside air relative humidity


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

Description: Current engine room air temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current main cabin air temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current refrigerator temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current freezer temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current heating temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


/aircraft/<RegExp>/environment/water

Description: Environmental conditions of the water that the vessel is sailing in


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

Units: K (Kelvin)

Description: Current water temperature


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

Units: ratio (Ratio)

Description: Water salinity


/aircraft/<RegExp>/environment/depth

Title: depth

Description: Depth related data


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

Units: m (Meter)

Description: Depth below keel


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

Units: m (Meter)

Description: Depth below Transducer


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

Units: m (Meter)

Description: Depth from surface


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

Units: m (Meter)

Description: Depth from the transducer to the bottom of the keel


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

Units: m (Meter)

Description: Depth transducer is below the water surface


/aircraft/<RegExp>/environment/current

Title: current

Description: Direction and strength of current affecting the vessel

Fields:

  • drift (The speed component of the water current vector), units: m/s (Meters per second)
  • setTrue (The direction component of the water current vector referenced to true (geographic) north), units: rad (Radian)
  • setMagnetic (The direction component of the water current vector referenced to magnetic north), units: rad (Radian)

/aircraft/<RegExp>/environment/tide

Title: tide

Description: Tide data


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

Units: m (Meter)

Description: Next high tide height relative to lowest astronomical tide (LAT/Chart Datum)


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

Units: m (Meter)

Description: The current tide height relative to lowest astronomical tide (LAT/Chart Datum)


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

Units: m (Meter)

Description: The next low tide height relative to lowest astronomical tide (LAT/Chart Datum)


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

Units: RFC 3339 (UTC) (undefined)

Description: Time of the next low tide in UTC


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

Units: RFC 3339 (UTC) (undefined)

Description: Time of next high tide in UTC


/aircraft/<RegExp>/environment/heave

Units: m (Meter)

Description: Vertical movement of the vessel due to waves


/aircraft/<RegExp>/environment/wind

Title: wind

Description: Wind data.


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

Units: rad (Radian)

Description: Apparent wind angle, negative to port


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

Units: rad (Radian)

Description: True wind angle based on speed over ground, negative to port


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

Units: rad (Radian)

Description: True wind angle based on speed through water, negative to port


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

Units: rad (Radian)

Description: The angle the wind needs to shift to raise an alarm


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

Units: rad (Radian)

Description: The wind direction relative to true north


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

Units: rad (Radian)

Description: The wind direction relative to magnetic north


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

Units: m/s (Meters per second)

Description: Wind speed over water (as calculated from speedApparent and vessel's speed through water)


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

Units: m/s (Meters per second)

Description: Wind speed over ground (as calculated from speedApparent and vessel's speed over ground)


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

Units: m/s (Meters per second)

Description: Apparent wind speed


/aircraft/<RegExp>/environment/time

Description: A time reference for the vessel. All clocks on the vessel dispaying local time should use the timezone offset here. If a timezoneRegion is supplied the timezone must also be supplied. If timezoneRegion is supplied that should be displayed by UIs in preference to simply timezone. ie 12:05 (Europe/London) should be displayed in preference to 12:05 (UTC+01:00)

Fields:

  • millis (Milliseconds since the UNIX epoch (1970-01-01 00:00:00))
  • timezoneOffset (Onboard timezone offset from UTC in hours and minutes (-)hhmm. +ve means east of Greenwich. For use by UIs)
  • timezoneRegion (Onboard timezone offset as listed in the IANA timezone database (tz database))

/aircraft/<RegExp>/environment/mode

Description: Mode of the vessel based on the current conditions. Can be combined with navigation.state to control vessel signals eg switch to night mode for instrumentation and lights, or make sound signals for fog.


/aircraft/<RegExp>/navigation

Title: navigation

Description: Navigation data including Position, Course to next WP information, etc.


/aircraft/<RegExp>/navigation/lights

Title: Navigation lights

Description: Current state of the vessels navigation lights


/aircraft/<RegExp>/navigation/courseOverGroundMagnetic

Units: rad (Radian)

Description: Course over ground (magnetic)


/aircraft/<RegExp>/navigation/courseOverGroundTrue

Units: rad (Radian)

Description: Course over ground (true)


/aircraft/<RegExp>/navigation/courseRhumbline

Title: Course

Description: Course information computed with Rhumbline


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

Units: m (Meter)

Description: The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate).


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

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to true north.


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

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to magnetic north.


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

Description: Data required if sailing to an active route, defined in resources.


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

Description: A reference (URL) to the presently active route, in resources.


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

Description: The estimated time of arrival at the end of the current route


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

Description: The time this route was activated


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

Description: The point on earth the vessel's presently navigating towards

Fields:

  • position (The position of nextPoint in two dimensions)

    • latitude
    • longitude

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

Units: m (Meter)

Description: The distance in meters between the vessel's present position and the nextPoint


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

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to true north


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

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to magnetic north


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

Units: m/s (Meters per second)

Description: The velocity component of the vessel towards the nextPoint


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

Units: s (Second)

Description: Time in seconds to reach nextPoint's perpendicular) with current speed & direction


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

Description: The point on earth the vessel's presently navigating from

Fields:

  • position (The position of lastPoint in two dimensions)

    • latitude
    • longitude

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

Units: m (Meter)

Description: The distance in meters between previousPoint and the vessel's present position


/aircraft/<RegExp>/navigation/courseGreatCircle

Title: Course

Description: Course information computed with Great Circle


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

Units: m (Meter)

Description: The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate).


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

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to true north.


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

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to magnetic north.


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

Description: Data required if sailing to an active route, defined in resources.


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

Description: A reference (URL) to the presently active route, in resources.


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

Description: The estimated time of arrival at the end of the current route


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

Description: The time this route was activated


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

Description: The point on earth the vessel's presently navigating towards

Fields:

  • position (The position of nextPoint in two dimensions)

    • latitude
    • longitude

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

Units: m (Meter)

Description: The distance in meters between the vessel's present position and the nextPoint


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

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to true north


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

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to magnetic north


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

Units: m/s (Meters per second)

Description: The velocity component of the vessel towards the nextPoint


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

Units: s (Second)

Description: Time in seconds to reach nextPoint's perpendicular) with current speed & direction


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

Description: The point on earth the vessel's presently navigating from

Fields:

  • position (The position of lastPoint in two dimensions)

    • latitude
    • longitude

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

Units: m (Meter)

Description: The distance in meters between previousPoint and the vessel's present position


/aircraft/<RegExp>/navigation/racing

Description: Specific navigational data related to yacht racing.


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

Description: Position of starboard start mark


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

Description: Position of starboard start mark


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

Units: m (Meter)

Description: The current distance to the start line


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

Units: s (Second)

Description: Time left before start


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

Units: s (Second)

Description: Time to arrive at the start line on port, turning downwind


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

Units: s (Second)

Description: Time to arrive at the start line on port, turning upwind


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

Units: s (Second)

Description: Time to arrive at the start line on starboard, turning downwind


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

Units: s (Second)

Description: Time to arrive at the start line on starboard, turning upwind


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

Units: m (Meter)

Description: The current distance to the layline


/aircraft/<RegExp>/navigation/magneticVariation

Units: rad (Radian)

Description: The magnetic variation (declination) at the current position


/aircraft/<RegExp>/navigation/magneticVariationAgeOfService

Units: s (Second)

Description: Seconds since the 1st Jan 1970 that the variation calculation was made


/aircraft/<RegExp>/navigation/destination

Title: destination

Description: The intended destination of this trip


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

Description: Common name of the Destination, eg 'Fiji', also used in ais messages


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

Description: Expected time of arrival at destination waypoint


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

Description: UUID of destination waypoint


/aircraft/<RegExp>/navigation/gnss

Title: gnss

Description: Global satellite navigation meta information


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

Description: Fix type


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

Description: Quality of the satellite fix


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

Description: Integrity of the satellite fix


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

Description: Number of satellites


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

Units: m (Meter)

Description: Altitude of antenna


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

Description: Horizontal Dilution of Precision


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

Description: Positional Dilution of Precision


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

Description: Difference between WGS84 earth ellipsoid and mean sea level


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

Units: s (Second)

Description: Age of DGPS data


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

Description: ID of DGPS base station


/aircraft/<RegExp>/navigation/headingMagnetic

Units: rad (Radian)

Description: Current magnetic heading of the vessel


/aircraft/<RegExp>/navigation/headingTrue

Units: rad (Radian)

Description: The current true heading of the vessel


/aircraft/<RegExp>/navigation/position

Title: position

Description: The position of the vessel in 2 or 3 dimensions (WGS84 datum)

Fields:

  • longitude (Longitude), units: deg (Degree)
  • latitude (Latitude), units: deg (Degree)
  • altitude (Altitude), units: m (Meter)

/aircraft/<RegExp>/navigation/attitude

Title: Attitude

Description: Vessel attitude: roll, pitch and yaw

Fields:

  • roll (Vessel roll, +ve is list to starboard), units: rad (Radian)
  • pitch (Pitch, +ve is bow up), units: rad (Radian)
  • yaw (Yaw, +ve is heading change to starboard), units: rad (Radian)

/aircraft/<RegExp>/navigation/maneuver

Description: Special maneuver such as regional passing arrangement. (from ais)


/aircraft/<RegExp>/navigation/rateOfTurn

Units: rad/s (Radian per second)

Description: Rate of turn (+ve is change to starboard). If the value is AIS RIGHT or LEFT, set to +-0.0206 rads and add warning in notifications


/aircraft/<RegExp>/navigation/speedOverGround

Units: m/s (Meters per second)

Description: Vessel speed over ground. If converting from AIS 'HIGH' value, set to 102.2 (Ais max value) and add warning in notifications


/aircraft/<RegExp>/navigation/speedThroughWater

Units: m/s (Meters per second)

Description: Vessel speed through the water


/aircraft/<RegExp>/navigation/speedThroughWaterTransverse

Units: m/s (Meters per second)

Description: Transverse speed through the water (Leeway)


/aircraft/<RegExp>/navigation/speedThroughWaterLongitudinal

Units: m/s (Meters per second)

Description: Longitudinal speed through the water


/aircraft/<RegExp>/navigation/leewayAngle

Units: rad (Radian)

Description: Leeway Angle derived from the longitudinal and transverse speeds through the water


/aircraft/<RegExp>/navigation/log

Units: m (Meter)

Description: Total distance traveled


/aircraft/<RegExp>/navigation/trip

Description: Trip data


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

Units: m (Meter)

Description: Total distance traveled on this trip / since trip reset


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

Description: Trip log reset time


/aircraft/<RegExp>/navigation/state

Title: state

Description: Current navigational state of the vessel


/aircraft/<RegExp>/navigation/anchor

Title: anchor

Description: The anchor data, for anchor watch etc


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

Units: m (Meter)

Description: Radius of anchor alarm boundary. The distance from anchor to the center of the boat


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

Units: m (Meter)

Description: Current distance to anchor


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

Title: position

Description: The actual anchor position of the vessel in 3 dimensions, probably an estimate at best

Fields:

  • longitude (Longitude), units: deg (Degree)
  • latitude (Latitude), units: deg (Degree)
  • altitude (Altitude), units: m (Meter)

/aircraft/<RegExp>/navigation/datetime

Description: Time and Date from the GNSS Positioning System

Fields:

  • gnssTimeSource (Source of GNSS Date and Time), enum:

    • GPS
    • GLONASS
    • Galileo
    • Beidou
    • IRNSS
    • Radio Signal
    • Internet
    • Local clock

/aircraft/<RegExp>/notifications

Title: notifications

Description: Notifications currently raised. Major categories have well-defined names, but the tree can be extended by any hierarchical structure


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

Description: This regex pattern is used for validation of the path of the alarm


/aircraft/<RegExp>/design

Title: design

Description: Design/dimensional data of this aircraft


/aircraft/<RegExp>/design/displacement

Units: kg (Kilogram)

Description: The displacement of the vessel


/aircraft/<RegExp>/design/aisShipType

Description: The ais ship type and cargo, see http://www.bosunsmate.org/ais/message5.php

Enum values:

  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99

/aircraft/<RegExp>/design/draft

Title: draft

Description: The draft of the vessel

Fields:

  • minimum (The minimum draft of the vessel), units: m (Meter)
  • maximum (The maximum draft of the vessel), units: m (Meter)
  • canoe (The draft of the vessel without protrusions such as keel, centerboard, rudder), units: m (Meter)

/aircraft/<RegExp>/design/length

Title: length

Description: The various lengths of the vessel

Fields:

  • overall (Length overall), units: m (Meter)
  • hull (Length of hull), units: m (Meter)
  • waterline (Length at waterline), units: m (Meter)

/aircraft/<RegExp>/design/keel

Title: keel

Description: Information about the vessel's keel

Fields:

  • type (The type of keel.), enum:

    • long
    • fin
    • flare
    • bulb
    • wing
    • centerboard
    • kanting
    • lifting
    • daggerboard

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

Units: rad (Radian)

Description: A number indicating at which angle the keel currently is (in case of a canting keel), negative to port.


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

Units: ratio (Ratio)

Description: In the case of a lifting keel, centreboard or daggerboard, the part of the keel which is extended. 0 is 'all the way up' and 1 is 'all the way down'. 0.8 would be 80% down.


/aircraft/<RegExp>/design/beam

Units: m (Meter)

Description: Beam length


/aircraft/<RegExp>/design/airHeight

Units: m (Meter)

Description: Total height of the vessel


/aircraft/<RegExp>/design/rigging

Title: rigging

Description: Information about the vessel's rigging

Fields:

  • configuration (The configuration of the rigging)
  • masts (The number of masts on the vessel.)

/aircraft/<RegExp>/sensors

Title: sensors

Description: Sensors, their state, and data.


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

Title: sensor

Description: This regex pattern is used for validation UUID identifier for the sensor


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

Description: The common name of the sensor


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

Description: The datamodel definition of the sensor data. FIXME - need to create a definitions lib of sensor datamodel types


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

Description: The data of the sensor data. FIXME - need to ref the definitions of sensor types


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

Description: The distance from the bow to the sensor location


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

Description: The distance from the centerline to the sensor location, -ve to starboard, +ve to port


/aton

Description: A wrapper object for Aids to Navigation (aton's)


/aton/<RegExp>

Title: aid to navigation

Description: This regex pattern is used for validation of an MMSI or Signal K UUID identifier for the aid to navigation. Examples: urn:mrn:imo:mmsi:991099999 urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d


/aton/<RegExp>/url

Description: URL based identity of the aid to navigation, if available.


/aton/<RegExp>/mmsi

Description: MMSI number of the aid to navigation, if available.


/aton/<RegExp>/uuid

Description: A unique Signal K flavoured maritime resource identifier, assigned by the server.


/aton/<RegExp>/atonType

Description: [missing]

Enum values:

  • 0 Default, Type of AtoN not specified
  • 1 Reference point
  • 2 RACON
  • 3 Fixed structures off-shore, such as oil platforms, wind farms.
  • 4 Emergency Wreck Marking Buoy
  • 5 Light, without sectors
  • 6 Light, with sectors
  • 7 Leading Light Front
  • 8 Leading Light Rear
  • 9 Beacon, Cardinal N
  • 10 Beacon, Cardinal E
  • 11 Beacon, Cardinal S
  • 12 Beacon, Cardinal W
  • 13 Beacon, Port hand
  • 14 Beacon, Starboard hand
  • 15 Beacon, Preferred Channel port hand
  • 16 Beacon, Preferred Channel starboard hand
  • 17 Beacon, Isolated danger
  • 18 Beacon, Safe water
  • 19 Beacon, Special mark
  • 20 Cardinal Mark N
  • 21 Cardinal Mark E
  • 22 Cardinal Mark S
  • 23 Cardinal Mark W
  • 24 Port hand Mark
  • 25 Starboard hand Mark
  • 26 Preferred Channel Port hand
  • 27 Preferred Channel Starboard hand
  • 28 Isolated danger
  • 29 Safe Water
  • 30 Special Mark
  • 31 Light Vessel/LANBY/Rigs

/aton/<RegExp>/name

Description: The aton name


/aton/<RegExp>/communication

Title: communication

Description: Communication data including Radio, Telephone, E-Mail, etc.


/aton/<RegExp>/communication/callsignVhf

Description: Callsign for VHF communication


/aton/<RegExp>/communication/callsignHf

Description: Callsign for HF communication


/aton/<RegExp>/communication/phoneNumber

Description: Phone number of skipper


/aton/<RegExp>/communication/emailHf

Description: Email address to be used for HF email (Winmail, Airmail, Sailmail)


/aton/<RegExp>/communication/email

Description: Regular email for the skipper


/aton/<RegExp>/communication/satPhoneNumber

Description: Satellite phone number for vessel.


/aton/<RegExp>/communication/skipperName

Description: Full name of the skipper of the vessel.


/aton/<RegExp>/communication/crewNames

Description: Array with the names of the crew


/aton/<RegExp>/environment

Title: environment

Description: Environmental data measured locally including Depth, Wind, Temp, etc.


/aton/<RegExp>/environment/outside

Description: Environmental conditions outside of the vessel's hull


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

Units: K (Kelvin)

Description: Current outside air temperature


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

Units: K (Kelvin)

Description: Current outside dew point temperature


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

Units: K (Kelvin)

Description: Current outside apparent wind chill temperature


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

Units: K (Kelvin)

Description: Current outside theoretical wind chill temperature


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

Units: K (Kelvin)

Description: Current outside heat index temperature


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

Units: Pa (Pascal)

Description: Current outside air ambient pressure


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

Units: ratio (Ratio)

Description: Current outside air relative humidity


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

Units: Lux (undefined)

Description: Current outside ambient light flux.


/aton/<RegExp>/environment/inside

Description: Environmental conditions inside the vessel's hull


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

Units: K (Kelvin)

Description: Current inside air temperature


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

Units: ratio (Ratio)

Description: Current inside air relative humidity


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

Description: Current engine room air temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current main cabin air temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current refrigerator temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current freezer temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current heating temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


/aton/<RegExp>/environment/water

Description: Environmental conditions of the water that the vessel is sailing in


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

Units: K (Kelvin)

Description: Current water temperature


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

Units: ratio (Ratio)

Description: Water salinity


/aton/<RegExp>/environment/depth

Title: depth

Description: Depth related data


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

Units: m (Meter)

Description: Depth below keel


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

Units: m (Meter)

Description: Depth below Transducer


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

Units: m (Meter)

Description: Depth from surface


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

Units: m (Meter)

Description: Depth from the transducer to the bottom of the keel


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

Units: m (Meter)

Description: Depth transducer is below the water surface


/aton/<RegExp>/environment/current

Title: current

Description: Direction and strength of current affecting the vessel

Fields:

  • drift (The speed component of the water current vector), units: m/s (Meters per second)
  • setTrue (The direction component of the water current vector referenced to true (geographic) north), units: rad (Radian)
  • setMagnetic (The direction component of the water current vector referenced to magnetic north), units: rad (Radian)

/aton/<RegExp>/environment/tide

Title: tide

Description: Tide data


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

Units: m (Meter)

Description: Next high tide height relative to lowest astronomical tide (LAT/Chart Datum)


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

Units: m (Meter)

Description: The current tide height relative to lowest astronomical tide (LAT/Chart Datum)


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

Units: m (Meter)

Description: The next low tide height relative to lowest astronomical tide (LAT/Chart Datum)


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

Units: RFC 3339 (UTC) (undefined)

Description: Time of the next low tide in UTC


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

Units: RFC 3339 (UTC) (undefined)

Description: Time of next high tide in UTC


/aton/<RegExp>/environment/heave

Units: m (Meter)

Description: Vertical movement of the vessel due to waves


/aton/<RegExp>/environment/wind

Title: wind

Description: Wind data.


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

Units: rad (Radian)

Description: Apparent wind angle, negative to port


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

Units: rad (Radian)

Description: True wind angle based on speed over ground, negative to port


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

Units: rad (Radian)

Description: True wind angle based on speed through water, negative to port


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

Units: rad (Radian)

Description: The angle the wind needs to shift to raise an alarm


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

Units: rad (Radian)

Description: The wind direction relative to true north


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

Units: rad (Radian)

Description: The wind direction relative to magnetic north


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

Units: m/s (Meters per second)

Description: Wind speed over water (as calculated from speedApparent and vessel's speed through water)


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

Units: m/s (Meters per second)

Description: Wind speed over ground (as calculated from speedApparent and vessel's speed over ground)


/aton/<RegExp>/environment/wind/speedApparent

Units: m/s (Meters per second)

Description: Apparent wind speed


/aton/<RegExp>/environment/time

Description: A time reference for the vessel. All clocks on the vessel dispaying local time should use the timezone offset here. If a timezoneRegion is supplied the timezone must also be supplied. If timezoneRegion is supplied that should be displayed by UIs in preference to simply timezone. ie 12:05 (Europe/London) should be displayed in preference to 12:05 (UTC+01:00)

Fields:

  • millis (Milliseconds since the UNIX epoch (1970-01-01 00:00:00))
  • timezoneOffset (Onboard timezone offset from UTC in hours and minutes (-)hhmm. +ve means east of Greenwich. For use by UIs)
  • timezoneRegion (Onboard timezone offset as listed in the IANA timezone database (tz database))

/aton/<RegExp>/environment/mode

Description: Mode of the vessel based on the current conditions. Can be combined with navigation.state to control vessel signals eg switch to night mode for instrumentation and lights, or make sound signals for fog.


/aton/<RegExp>/navigation

Title: navigation

Description: Navigation data including Position, Course to next WP information, etc.


/aton/<RegExp>/navigation/lights

Title: Navigation lights

Description: Current state of the vessels navigation lights


/aton/<RegExp>/navigation/courseOverGroundMagnetic

Units: rad (Radian)

Description: Course over ground (magnetic)


/aton/<RegExp>/navigation/courseOverGroundTrue

Units: rad (Radian)

Description: Course over ground (true)


/aton/<RegExp>/navigation/courseRhumbline

Title: Course

Description: Course information computed with Rhumbline


/aton/<RegExp>/navigation/courseRhumbline/crossTrackError

Units: m (Meter)

Description: The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate).


/aton/<RegExp>/navigation/courseRhumbline/bearingTrackTrue

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to true north.


/aton/<RegExp>/navigation/courseRhumbline/bearingTrackMagnetic

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to magnetic north.


/aton/<RegExp>/navigation/courseRhumbline/activeRoute

Description: Data required if sailing to an active route, defined in resources.


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

Description: A reference (URL) to the presently active route, in resources.


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

Description: The estimated time of arrival at the end of the current route


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

Description: The time this route was activated


/aton/<RegExp>/navigation/courseRhumbline/nextPoint

Description: The point on earth the vessel's presently navigating towards

Fields:

  • position (The position of nextPoint in two dimensions)

    • latitude
    • longitude

/aton/<RegExp>/navigation/courseRhumbline/nextPoint/distance

Units: m (Meter)

Description: The distance in meters between the vessel's present position and the nextPoint


/aton/<RegExp>/navigation/courseRhumbline/nextPoint/bearingTrue

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to true north


/aton/<RegExp>/navigation/courseRhumbline/nextPoint/bearingMagnetic

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to magnetic north


/aton/<RegExp>/navigation/courseRhumbline/nextPoint/velocityMadeGood

Units: m/s (Meters per second)

Description: The velocity component of the vessel towards the nextPoint


/aton/<RegExp>/navigation/courseRhumbline/nextPoint/timeToGo

Units: s (Second)

Description: Time in seconds to reach nextPoint's perpendicular) with current speed & direction


/aton/<RegExp>/navigation/courseRhumbline/previousPoint

Description: The point on earth the vessel's presently navigating from

Fields:

  • position (The position of lastPoint in two dimensions)

    • latitude
    • longitude

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

Units: m (Meter)

Description: The distance in meters between previousPoint and the vessel's present position


/aton/<RegExp>/navigation/courseGreatCircle

Title: Course

Description: Course information computed with Great Circle


/aton/<RegExp>/navigation/courseGreatCircle/crossTrackError

Units: m (Meter)

Description: The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate).


/aton/<RegExp>/navigation/courseGreatCircle/bearingTrackTrue

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to true north.


/aton/<RegExp>/navigation/courseGreatCircle/bearingTrackMagnetic

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to magnetic north.


/aton/<RegExp>/navigation/courseGreatCircle/activeRoute

Description: Data required if sailing to an active route, defined in resources.


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

Description: A reference (URL) to the presently active route, in resources.


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

Description: The estimated time of arrival at the end of the current route


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

Description: The time this route was activated


/aton/<RegExp>/navigation/courseGreatCircle/nextPoint

Description: The point on earth the vessel's presently navigating towards

Fields:

  • position (The position of nextPoint in two dimensions)

    • latitude
    • longitude

/aton/<RegExp>/navigation/courseGreatCircle/nextPoint/distance

Units: m (Meter)

Description: The distance in meters between the vessel's present position and the nextPoint


/aton/<RegExp>/navigation/courseGreatCircle/nextPoint/bearingTrue

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to true north


/aton/<RegExp>/navigation/courseGreatCircle/nextPoint/bearingMagnetic

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to magnetic north


/aton/<RegExp>/navigation/courseGreatCircle/nextPoint/velocityMadeGood

Units: m/s (Meters per second)

Description: The velocity component of the vessel towards the nextPoint


/aton/<RegExp>/navigation/courseGreatCircle/nextPoint/timeToGo

Units: s (Second)

Description: Time in seconds to reach nextPoint's perpendicular) with current speed & direction


/aton/<RegExp>/navigation/courseGreatCircle/previousPoint

Description: The point on earth the vessel's presently navigating from

Fields:

  • position (The position of lastPoint in two dimensions)

    • latitude
    • longitude

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

Units: m (Meter)

Description: The distance in meters between previousPoint and the vessel's present position


/aton/<RegExp>/navigation/racing

Description: Specific navigational data related to yacht racing.


/aton/<RegExp>/navigation/racing/startLineStb

Description: Position of starboard start mark


/aton/<RegExp>/navigation/racing/startLinePort

Description: Position of starboard start mark


/aton/<RegExp>/navigation/racing/distanceStartline

Units: m (Meter)

Description: The current distance to the start line


/aton/<RegExp>/navigation/racing/timeToStart

Units: s (Second)

Description: Time left before start


/aton/<RegExp>/navigation/racing/timePortDown

Units: s (Second)

Description: Time to arrive at the start line on port, turning downwind


/aton/<RegExp>/navigation/racing/timePortUp

Units: s (Second)

Description: Time to arrive at the start line on port, turning upwind


/aton/<RegExp>/navigation/racing/timeStbdDown

Units: s (Second)

Description: Time to arrive at the start line on starboard, turning downwind


/aton/<RegExp>/navigation/racing/timeStbdUp

Units: s (Second)

Description: Time to arrive at the start line on starboard, turning upwind


/aton/<RegExp>/navigation/racing/distanceLayline

Units: m (Meter)

Description: The current distance to the layline


/aton/<RegExp>/navigation/magneticVariation

Units: rad (Radian)

Description: The magnetic variation (declination) at the current position


/aton/<RegExp>/navigation/magneticVariationAgeOfService

Units: s (Second)

Description: Seconds since the 1st Jan 1970 that the variation calculation was made


/aton/<RegExp>/navigation/destination

Title: destination

Description: The intended destination of this trip


/aton/<RegExp>/navigation/destination/commonName

Description: Common name of the Destination, eg 'Fiji', also used in ais messages


/aton/<RegExp>/navigation/destination/eta

Description: Expected time of arrival at destination waypoint


/aton/<RegExp>/navigation/destination/waypoint

Description: UUID of destination waypoint


/aton/<RegExp>/navigation/gnss

Title: gnss

Description: Global satellite navigation meta information


/aton/<RegExp>/navigation/gnss/type

Description: Fix type


/aton/<RegExp>/navigation/gnss/methodQuality

Description: Quality of the satellite fix


/aton/<RegExp>/navigation/gnss/integrity

Description: Integrity of the satellite fix


/aton/<RegExp>/navigation/gnss/satellites

Description: Number of satellites


/aton/<RegExp>/navigation/gnss/antennaAltitude

Units: m (Meter)

Description: Altitude of antenna


/aton/<RegExp>/navigation/gnss/horizontalDilution

Description: Horizontal Dilution of Precision


/aton/<RegExp>/navigation/gnss/positionDilution

Description: Positional Dilution of Precision


/aton/<RegExp>/navigation/gnss/geoidalSeparation

Description: Difference between WGS84 earth ellipsoid and mean sea level


/aton/<RegExp>/navigation/gnss/differentialAge

Units: s (Second)

Description: Age of DGPS data


/aton/<RegExp>/navigation/gnss/differentialReference

Description: ID of DGPS base station


/aton/<RegExp>/navigation/headingMagnetic

Units: rad (Radian)

Description: Current magnetic heading of the vessel


/aton/<RegExp>/navigation/headingTrue

Units: rad (Radian)

Description: The current true heading of the vessel


/aton/<RegExp>/navigation/position

Title: position

Description: The position of the vessel in 2 or 3 dimensions (WGS84 datum)

Fields:

  • longitude (Longitude), units: deg (Degree)
  • latitude (Latitude), units: deg (Degree)
  • altitude (Altitude), units: m (Meter)

/aton/<RegExp>/navigation/attitude

Title: Attitude

Description: Vessel attitude: roll, pitch and yaw

Fields:

  • roll (Vessel roll, +ve is list to starboard), units: rad (Radian)
  • pitch (Pitch, +ve is bow up), units: rad (Radian)
  • yaw (Yaw, +ve is heading change to starboard), units: rad (Radian)

/aton/<RegExp>/navigation/maneuver

Description: Special maneuver such as regional passing arrangement. (from ais)


/aton/<RegExp>/navigation/rateOfTurn

Units: rad/s (Radian per second)

Description: Rate of turn (+ve is change to starboard). If the value is AIS RIGHT or LEFT, set to +-0.0206 rads and add warning in notifications


/aton/<RegExp>/navigation/speedOverGround

Units: m/s (Meters per second)

Description: Vessel speed over ground. If converting from AIS 'HIGH' value, set to 102.2 (Ais max value) and add warning in notifications


/aton/<RegExp>/navigation/speedThroughWater

Units: m/s (Meters per second)

Description: Vessel speed through the water


/aton/<RegExp>/navigation/speedThroughWaterTransverse

Units: m/s (Meters per second)

Description: Transverse speed through the water (Leeway)


/aton/<RegExp>/navigation/speedThroughWaterLongitudinal

Units: m/s (Meters per second)

Description: Longitudinal speed through the water


/aton/<RegExp>/navigation/leewayAngle

Units: rad (Radian)

Description: Leeway Angle derived from the longitudinal and transverse speeds through the water


/aton/<RegExp>/navigation/log

Units: m (Meter)

Description: Total distance traveled


/aton/<RegExp>/navigation/trip

Description: Trip data


/aton/<RegExp>/navigation/trip/log

Units: m (Meter)

Description: Total distance traveled on this trip / since trip reset


/aton/<RegExp>/navigation/trip/lastReset

Description: Trip log reset time


/aton/<RegExp>/navigation/state

Title: state

Description: Current navigational state of the vessel


/aton/<RegExp>/navigation/anchor

Title: anchor

Description: The anchor data, for anchor watch etc


/aton/<RegExp>/navigation/anchor/maxRadius

Units: m (Meter)

Description: Radius of anchor alarm boundary. The distance from anchor to the center of the boat


/aton/<RegExp>/navigation/anchor/currentRadius

Units: m (Meter)

Description: Current distance to anchor


/aton/<RegExp>/navigation/anchor/position

Title: position

Description: The actual anchor position of the vessel in 3 dimensions, probably an estimate at best

Fields:

  • longitude (Longitude), units: deg (Degree)
  • latitude (Latitude), units: deg (Degree)
  • altitude (Altitude), units: m (Meter)

/aton/<RegExp>/navigation/datetime

Description: Time and Date from the GNSS Positioning System

Fields:

  • gnssTimeSource (Source of GNSS Date and Time), enum:

    • GPS
    • GLONASS
    • Galileo
    • Beidou
    • IRNSS
    • Radio Signal
    • Internet
    • Local clock

/aton/<RegExp>/notifications

Title: notifications

Description: Notifications currently raised. Major categories have well-defined names, but the tree can be extended by any hierarchical structure


/aton/<RegExp>/notifications/<RegExp>

Description: This regex pattern is used for validation of the path of the alarm


/aton/<RegExp>/design

Title: design

Description: Design/dimensional data of this


/aton/<RegExp>/design/displacement

Units: kg (Kilogram)

Description: The displacement of the vessel


/aton/<RegExp>/design/aisShipType

Description: The ais ship type and cargo, see http://www.bosunsmate.org/ais/message5.php

Enum values:

  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99

/aton/<RegExp>/design/draft

Title: draft

Description: The draft of the vessel

Fields:

  • minimum (The minimum draft of the vessel), units: m (Meter)
  • maximum (The maximum draft of the vessel), units: m (Meter)
  • canoe (The draft of the vessel without protrusions such as keel, centerboard, rudder), units: m (Meter)

/aton/<RegExp>/design/length

Title: length

Description: The various lengths of the vessel

Fields:

  • overall (Length overall), units: m (Meter)
  • hull (Length of hull), units: m (Meter)
  • waterline (Length at waterline), units: m (Meter)

/aton/<RegExp>/design/keel

Title: keel

Description: Information about the vessel's keel

Fields:

  • type (The type of keel.), enum:

    • long
    • fin
    • flare
    • bulb
    • wing
    • centerboard
    • kanting
    • lifting
    • daggerboard

/aton/<RegExp>/design/keel/angle

Units: rad (Radian)

Description: A number indicating at which angle the keel currently is (in case of a canting keel), negative to port.


/aton/<RegExp>/design/keel/lift

Units: ratio (Ratio)

Description: In the case of a lifting keel, centreboard or daggerboard, the part of the keel which is extended. 0 is 'all the way up' and 1 is 'all the way down'. 0.8 would be 80% down.


/aton/<RegExp>/design/beam

Units: m (Meter)

Description: Beam length


/aton/<RegExp>/design/airHeight

Units: m (Meter)

Description: Total height of the vessel


/aton/<RegExp>/design/rigging

Title: rigging

Description: Information about the vessel's rigging

Fields:

  • configuration (The configuration of the rigging)
  • masts (The number of masts on the vessel.)

/aton/<RegExp>/sensors

Title: sensors

Description: Sensors, their state, and data.


/aton/<RegExp>/sensors/<RegExp>

Title: sensor

Description: This regex pattern is used for validation UUID identifier for the sensor


/aton/<RegExp>/sensors/<RegExp>/name

Description: The common name of the sensor


/aton/<RegExp>/sensors/<RegExp>/sensorType

Description: The datamodel definition of the sensor data. FIXME - need to create a definitions lib of sensor datamodel types


/aton/<RegExp>/sensors/<RegExp>/sensorData

Description: The data of the sensor data. FIXME - need to ref the definitions of sensor types


/aton/<RegExp>/sensors/<RegExp>/fromBow

Description: The distance from the bow to the sensor location


/aton/<RegExp>/sensors/<RegExp>/fromCenter

Description: The distance from the centerline to the sensor location, -ve to starboard, +ve to port


/sar

Description: A wrapper object for Search And Rescue (SAR) MMSI's usied in transponders. MOB, EPIRBS etc


/sar/<RegExp>

Title: Search and rescue beacons

Description: This regex pattern is used for validation of an MMSI or Signal K UUID identifier for the aid to navigation. Examples: urn:mrn:imo:mmsi:972099999 urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d


/sar/<RegExp>/url

Description: URL based identity of the aid to navigation, if available.


/sar/<RegExp>/mmsi

Description: MMSI number of the aid to navigation, if available.


/sar/<RegExp>/uuid

Description: A unique Signal K flavoured maritime resource identifier, assigned by the server.


/sar/<RegExp>/communication

Title: communication

Description: Communication data including Radio, Telephone, E-Mail, etc.


/sar/<RegExp>/communication/callsignVhf

Description: Callsign for VHF communication


/sar/<RegExp>/communication/callsignHf

Description: Callsign for HF communication


/sar/<RegExp>/communication/phoneNumber

Description: Phone number of skipper


/sar/<RegExp>/communication/emailHf

Description: Email address to be used for HF email (Winmail, Airmail, Sailmail)


/sar/<RegExp>/communication/email

Description: Regular email for the skipper


/sar/<RegExp>/communication/satPhoneNumber

Description: Satellite phone number for vessel.


/sar/<RegExp>/communication/skipperName

Description: Full name of the skipper of the vessel.


/sar/<RegExp>/communication/crewNames

Description: Array with the names of the crew


/sar/<RegExp>/navigation

Title: navigation

Description: Navigation data including Position, Course to next WP information, etc.


/sar/<RegExp>/navigation/lights

Title: Navigation lights

Description: Current state of the vessels navigation lights


/sar/<RegExp>/navigation/courseOverGroundMagnetic

Units: rad (Radian)

Description: Course over ground (magnetic)


/sar/<RegExp>/navigation/courseOverGroundTrue

Units: rad (Radian)

Description: Course over ground (true)


/sar/<RegExp>/navigation/courseRhumbline

Title: Course

Description: Course information computed with Rhumbline


/sar/<RegExp>/navigation/courseRhumbline/crossTrackError

Units: m (Meter)

Description: The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate).


/sar/<RegExp>/navigation/courseRhumbline/bearingTrackTrue

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to true north.


/sar/<RegExp>/navigation/courseRhumbline/bearingTrackMagnetic

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to magnetic north.


/sar/<RegExp>/navigation/courseRhumbline/activeRoute

Description: Data required if sailing to an active route, defined in resources.


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

Description: A reference (URL) to the presently active route, in resources.


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

Description: The estimated time of arrival at the end of the current route


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

Description: The time this route was activated


/sar/<RegExp>/navigation/courseRhumbline/nextPoint

Description: The point on earth the vessel's presently navigating towards

Fields:

  • position (The position of nextPoint in two dimensions)

    • latitude
    • longitude

/sar/<RegExp>/navigation/courseRhumbline/nextPoint/distance

Units: m (Meter)

Description: The distance in meters between the vessel's present position and the nextPoint


/sar/<RegExp>/navigation/courseRhumbline/nextPoint/bearingTrue

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to true north


/sar/<RegExp>/navigation/courseRhumbline/nextPoint/bearingMagnetic

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to magnetic north


/sar/<RegExp>/navigation/courseRhumbline/nextPoint/velocityMadeGood

Units: m/s (Meters per second)

Description: The velocity component of the vessel towards the nextPoint


/sar/<RegExp>/navigation/courseRhumbline/nextPoint/timeToGo

Units: s (Second)

Description: Time in seconds to reach nextPoint's perpendicular) with current speed & direction


/sar/<RegExp>/navigation/courseRhumbline/previousPoint

Description: The point on earth the vessel's presently navigating from

Fields:

  • position (The position of lastPoint in two dimensions)

    • latitude
    • longitude

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

Units: m (Meter)

Description: The distance in meters between previousPoint and the vessel's present position


/sar/<RegExp>/navigation/courseGreatCircle

Title: Course

Description: Course information computed with Great Circle


/sar/<RegExp>/navigation/courseGreatCircle/crossTrackError

Units: m (Meter)

Description: The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate).


/sar/<RegExp>/navigation/courseGreatCircle/bearingTrackTrue

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to true north.


/sar/<RegExp>/navigation/courseGreatCircle/bearingTrackMagnetic

Units: rad (Radian)

Description: The bearing of a line between previousPoint and nextPoint, relative to magnetic north.


/sar/<RegExp>/navigation/courseGreatCircle/activeRoute

Description: Data required if sailing to an active route, defined in resources.


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

Description: A reference (URL) to the presently active route, in resources.


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

Description: The estimated time of arrival at the end of the current route


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

Description: The time this route was activated


/sar/<RegExp>/navigation/courseGreatCircle/nextPoint

Description: The point on earth the vessel's presently navigating towards

Fields:

  • position (The position of nextPoint in two dimensions)

    • latitude
    • longitude

/sar/<RegExp>/navigation/courseGreatCircle/nextPoint/distance

Units: m (Meter)

Description: The distance in meters between the vessel's present position and the nextPoint


/sar/<RegExp>/navigation/courseGreatCircle/nextPoint/bearingTrue

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to true north


/sar/<RegExp>/navigation/courseGreatCircle/nextPoint/bearingMagnetic

Units: rad (Radian)

Description: The bearing of a line between the vessel's current position and nextPoint, relative to magnetic north


/sar/<RegExp>/navigation/courseGreatCircle/nextPoint/velocityMadeGood

Units: m/s (Meters per second)

Description: The velocity component of the vessel towards the nextPoint


/sar/<RegExp>/navigation/courseGreatCircle/nextPoint/timeToGo

Units: s (Second)

Description: Time in seconds to reach nextPoint's perpendicular) with current speed & direction


/sar/<RegExp>/navigation/courseGreatCircle/previousPoint

Description: The point on earth the vessel's presently navigating from

Fields:

  • position (The position of lastPoint in two dimensions)

    • latitude
    • longitude

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

Units: m (Meter)

Description: The distance in meters between previousPoint and the vessel's present position


/sar/<RegExp>/navigation/racing

Description: Specific navigational data related to yacht racing.


/sar/<RegExp>/navigation/racing/startLineStb

Description: Position of starboard start mark


/sar/<RegExp>/navigation/racing/startLinePort

Description: Position of starboard start mark


/sar/<RegExp>/navigation/racing/distanceStartline

Units: m (Meter)

Description: The current distance to the start line


/sar/<RegExp>/navigation/racing/timeToStart

Units: s (Second)

Description: Time left before start


/sar/<RegExp>/navigation/racing/timePortDown

Units: s (Second)

Description: Time to arrive at the start line on port, turning downwind


/sar/<RegExp>/navigation/racing/timePortUp

Units: s (Second)

Description: Time to arrive at the start line on port, turning upwind


/sar/<RegExp>/navigation/racing/timeStbdDown

Units: s (Second)

Description: Time to arrive at the start line on starboard, turning downwind


/sar/<RegExp>/navigation/racing/timeStbdUp

Units: s (Second)

Description: Time to arrive at the start line on starboard, turning upwind


/sar/<RegExp>/navigation/racing/distanceLayline

Units: m (Meter)

Description: The current distance to the layline


/sar/<RegExp>/navigation/magneticVariation

Units: rad (Radian)

Description: The magnetic variation (declination) at the current position


/sar/<RegExp>/navigation/magneticVariationAgeOfService

Units: s (Second)

Description: Seconds since the 1st Jan 1970 that the variation calculation was made


/sar/<RegExp>/navigation/destination

Title: destination

Description: The intended destination of this trip


/sar/<RegExp>/navigation/destination/commonName

Description: Common name of the Destination, eg 'Fiji', also used in ais messages


/sar/<RegExp>/navigation/destination/eta

Description: Expected time of arrival at destination waypoint


/sar/<RegExp>/navigation/destination/waypoint

Description: UUID of destination waypoint


/sar/<RegExp>/navigation/gnss

Title: gnss

Description: Global satellite navigation meta information


/sar/<RegExp>/navigation/gnss/type

Description: Fix type


/sar/<RegExp>/navigation/gnss/methodQuality

Description: Quality of the satellite fix


/sar/<RegExp>/navigation/gnss/integrity

Description: Integrity of the satellite fix


/sar/<RegExp>/navigation/gnss/satellites

Description: Number of satellites


/sar/<RegExp>/navigation/gnss/antennaAltitude

Units: m (Meter)

Description: Altitude of antenna


/sar/<RegExp>/navigation/gnss/horizontalDilution

Description: Horizontal Dilution of Precision


/sar/<RegExp>/navigation/gnss/positionDilution

Description: Positional Dilution of Precision


/sar/<RegExp>/navigation/gnss/geoidalSeparation

Description: Difference between WGS84 earth ellipsoid and mean sea level


/sar/<RegExp>/navigation/gnss/differentialAge

Units: s (Second)

Description: Age of DGPS data


/sar/<RegExp>/navigation/gnss/differentialReference

Description: ID of DGPS base station


/sar/<RegExp>/navigation/headingMagnetic

Units: rad (Radian)

Description: Current magnetic heading of the vessel


/sar/<RegExp>/navigation/headingTrue

Units: rad (Radian)

Description: The current true heading of the vessel


/sar/<RegExp>/navigation/position

Title: position

Description: The position of the vessel in 2 or 3 dimensions (WGS84 datum)

Fields:

  • longitude (Longitude), units: deg (Degree)
  • latitude (Latitude), units: deg (Degree)
  • altitude (Altitude), units: m (Meter)

/sar/<RegExp>/navigation/attitude

Title: Attitude

Description: Vessel attitude: roll, pitch and yaw

Fields:

  • roll (Vessel roll, +ve is list to starboard), units: rad (Radian)
  • pitch (Pitch, +ve is bow up), units: rad (Radian)
  • yaw (Yaw, +ve is heading change to starboard), units: rad (Radian)

/sar/<RegExp>/navigation/maneuver

Description: Special maneuver such as regional passing arrangement. (from ais)


/sar/<RegExp>/navigation/rateOfTurn

Units: rad/s (Radian per second)

Description: Rate of turn (+ve is change to starboard). If the value is AIS RIGHT or LEFT, set to +-0.0206 rads and add warning in notifications


/sar/<RegExp>/navigation/speedOverGround

Units: m/s (Meters per second)

Description: Vessel speed over ground. If converting from AIS 'HIGH' value, set to 102.2 (Ais max value) and add warning in notifications


/sar/<RegExp>/navigation/speedThroughWater

Units: m/s (Meters per second)

Description: Vessel speed through the water


/sar/<RegExp>/navigation/speedThroughWaterTransverse

Units: m/s (Meters per second)

Description: Transverse speed through the water (Leeway)


/sar/<RegExp>/navigation/speedThroughWaterLongitudinal

Units: m/s (Meters per second)

Description: Longitudinal speed through the water


/sar/<RegExp>/navigation/leewayAngle

Units: rad (Radian)

Description: Leeway Angle derived from the longitudinal and transverse speeds through the water


/sar/<RegExp>/navigation/log

Units: m (Meter)

Description: Total distance traveled


/sar/<RegExp>/navigation/trip

Description: Trip data


/sar/<RegExp>/navigation/trip/log

Units: m (Meter)

Description: Total distance traveled on this trip / since trip reset


/sar/<RegExp>/navigation/trip/lastReset

Description: Trip log reset time


/sar/<RegExp>/navigation/state

Title: state

Description: Current navigational state of the vessel


/sar/<RegExp>/navigation/anchor

Title: anchor

Description: The anchor data, for anchor watch etc


/sar/<RegExp>/navigation/anchor/maxRadius

Units: m (Meter)

Description: Radius of anchor alarm boundary. The distance from anchor to the center of the boat


/sar/<RegExp>/navigation/anchor/currentRadius

Units: m (Meter)

Description: Current distance to anchor


/sar/<RegExp>/navigation/anchor/position

Title: position

Description: The actual anchor position of the vessel in 3 dimensions, probably an estimate at best

Fields:

  • longitude (Longitude), units: deg (Degree)
  • latitude (Latitude), units: deg (Degree)
  • altitude (Altitude), units: m (Meter)

/sar/<RegExp>/navigation/datetime

Description: Time and Date from the GNSS Positioning System

Fields:

  • gnssTimeSource (Source of GNSS Date and Time), enum:

    • GPS
    • GLONASS
    • Galileo
    • Beidou
    • IRNSS
    • Radio Signal
    • Internet
    • Local clock

/sar/<RegExp>/notifications

Title: notifications

Description: Notifications currently raised. Major categories have well-defined names, but the tree can be extended by any hierarchical structure


/sar/<RegExp>/notifications/mob

Description: Man overboard

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/fire

Description: Fire onboard

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/sinking

Description: Vessel is sinking

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/flooding

Description: Vessel is flooding

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/collision

Description: In collision with another vessel or object

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/grounding

Description: Vessel grounding

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/listing

Description: Vessel is listing

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/adrift

Description: Vessel is adrift

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/piracy

Description: Under attack or danger from pirates

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/abandon

Description: Abandon ship

Fields:

  • method (Method to use to raise notifications)
  • state (Current notification state), enum:

    • normal
    • alert
    • warn
    • alarm
    • emergency
  • message (Message to display or speak)


/sar/<RegExp>/notifications/<RegExp>

Description: This regex pattern is used for validation of the path of the alarm


/resources

Title: resources

Description: Resources to aid in navigation and operation of the vessel including waypoints, routes, notes, etc.


/resources/charts

Title: chart

Description: A holder for charts, each named with their chart code


/resources/charts/<RegExp>

Description: A chart

Fields:

  • name (Chart common name)
  • identifier (Chart number)
  • description (A description of the chart)
  • tilemapUrl (A url to the tilemap of the chart for use in TMS chartplotting apps)
  • region (Region related to note. A pointer to a region UUID. Alternative to geohash)
  • geohash (Position related to chart. Alternative to region)
  • chartUrl (A url to the chart file's storage location)
  • scale (The scale of the chart, the larger number from 1:200000)
  • chartLayers (If the chart format is WMS, the layers enabled for the chart.)
  • bounds (The bounds of the chart. An array containing the position of the upper left corner, and the lower right corner. Useful when the chart isn't inherently geo-referenced.)
  • chartFormat (The format of the chart), enum:

    • gif
    • geotiff
    • kap
    • png
    • jpg
    • kml
    • wkt
    • topojson
    • geojson
    • gpx
    • tms
    • wms
    • S-57
    • S-63
    • svg
    • other

/resources/routes

Title: route

Description: A holder for routes, each named with a UUID


/resources/routes/<RegExp>

Description: A route, named with a UUID

Fields:

  • name (Route's common name)
  • description (A description of the route)
  • distance (Total distance from start to end), units: m (Meter)
  • start (The waypoint UUID at the start of the route)
  • end (The waypoint UUID at the end of the route)
  • feature (A Geo JSON feature object which describes the route between the waypoints)

    • type, enum:

      • Feature
    • geometry

      • type, enum:

        • LineString
      • coordinates (An array of two or more positions)

  • properties (Additional data of any type)
  • id

/resources/notes

Title: notes

Description: A holder for notes about regions, each named with a UUID. Notes might include navigation or cruising info, images, or anything


/resources/notes/<RegExp>

Description: A note about a region, named with a UUID. Notes might include navigation or cruising info, images, or anything

Fields:

  • title (Note's common name)
  • description (A textual description of the note)
  • region (Region related to note. A pointer to a region UUID. Alternative to position or geohash)
  • geohash (Position related to note. Alternative to region or position)
  • mimeType (MIME type of the note)
  • url (Location of the note)

/resources/notes/<RegExp>/position

Title: position

Description: Position related to note. Alternative to region or geohash

Fields:

  • longitude (Longitude), units: deg (Degree)
  • latitude (Latitude), units: deg (Degree)
  • altitude (Altitude), units: m (Meter)

/resources/regions

Title: region

Description: A holder for regions, each named with UUID


/resources/regions/<RegExp>

Description: A region of interest, each named with a UUID

Fields:

  • geohash (geohash of the approximate boundary of this region)
  • feature (A Geo JSON feature object which describes the regions boundary)

    • type, enum:

      • Feature
    • geometry

    • properties (Additional data of any type)

    • id

/resources/waypoints

Title: waypoints

Description: A holder for waypoints, each named with a UUID


/resources/waypoints/<RegExp>

Description: A waypoint, named with a UUID


/resources/waypoints/<RegExp>/position

Title: position

Description: The position in 3 dimensions

Fields:

  • longitude (Longitude), units: deg (Degree)
  • latitude (Latitude), units: deg (Degree)
  • altitude (Altitude), units: m (Meter)

/resources/waypoints/<RegExp>/feature

Title: Feature

Description: A Geo JSON feature object


/resources/waypoints/<RegExp>/feature/type

Description: [missing]

Enum values:

  • Feature

/resources/waypoints/<RegExp>/feature/geometry

Title: Point

Description: [missing]


/resources/waypoints/<RegExp>/feature/geometry/type

Description: [missing]

Enum values:

  • Point

/resources/waypoints/<RegExp>/feature/geometry/coordinates

Description: A single position, in x,y order (Lon, Lat)


/resources/waypoints/<RegExp>/feature/properties

Description: Additional data of any type


/resources/waypoints/<RegExp>/feature/id

Description: [missing]


/version

Description: Version of the schema and APIs that this data is using in Canonical format i.e. V1.0.0.


results matching ""

    No results matching ""