/self
Description: This holds the context (prefix + UUID, MMSI or URL in dot notation) of the server's self object.
/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: DEPRECATED: use relativeHumidity
/aircraft/<RegExp>/environment/outside/relativeHumidity
Units: ratio (Ratio)
Description: Current outside air relative humidity
/aircraft/<RegExp>/environment/outside/airDensity
Units: kg/m3 (undefined)
Description: Current outside air density
/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: Temperature
/aircraft/<RegExp>/environment/inside/heatIndexTemperature
Units: K (Kelvin)
Description: Current heat index temperature in zone
/aircraft/<RegExp>/environment/inside/pressure
Units: Pa (Pascal)
Description: Pressure in zone
/aircraft/<RegExp>/environment/inside/relativeHumidity
Units: ratio (Ratio)
Description: Relative humidity in zone
/aircraft/<RegExp>/environment/inside/dewPoint
Units: K (Kelvin)
Description: DEPRECATED: use dewPointTemperature
/aircraft/<RegExp>/environment/inside/dewPointTemperature
Units: K (Kelvin)
Description: Dewpoint in zone
/aircraft/<RegExp>/environment/inside/airDensity
Units: kg/m3 (undefined)
Description: Air density in zone
/aircraft/<RegExp>/environment/inside/illuminance
Units: Lux (undefined)
Description: Illuminance in zone
/aircraft/<RegExp>/environment/inside/[A-Za-z0-9]+
Description: This regex pattern is used for validation of the identifier for the environmental zone, eg. engineRoom, mainCabin, refrigerator
/aircraft/<RegExp>/environment/inside/[A-Za-z0-9]+/temperature
Units: K (Kelvin)
Description: Temperature
/aircraft/<RegExp>/environment/inside/[A-Za-z0-9]+/heatIndexTemperature
Units: K (Kelvin)
Description: Current heat index temperature in zone
/aircraft/<RegExp>/environment/inside/[A-Za-z0-9]+/pressure
Units: Pa (Pascal)
Description: Pressure in zone
/aircraft/<RegExp>/environment/inside/[A-Za-z0-9]+/relativeHumidity
Units: ratio (Ratio)
Description: Relative humidity in zone
/aircraft/<RegExp>/environment/inside/[A-Za-z0-9]+/dewPoint
Units: K (Kelvin)
Description: DEPRECATED: use dewPointTemperature
/aircraft/<RegExp>/environment/inside/[A-Za-z0-9]+/dewPointTemperature
Units: K (Kelvin)
Description: Dewpoint in zone
/aircraft/<RegExp>/environment/inside/[A-Za-z0-9]+/airDensity
Units: kg/m3 (undefined)
Description: Air density in zone
/aircraft/<RegExp>/environment/inside/[A-Za-z0-9]+/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
Object value with properties
- drift (m/s)
- setTrue (rad)
- setMagnetic (rad)
/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: RFC 3339 (UTC only without local offset) string representing date and time.
/aircraft/<RegExp>/environment/tide/timeHigh
Units: RFC 3339 (UTC) (undefined)
Description: RFC 3339 (UTC only without local offset) string representing date and time.
/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)
/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
/aircraft/<RegExp>/navigation/courseRhumbline/previousPoint
Description: The point on earth the vessel's presently navigating from
Object value with properties
- type
- href
/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/courseRhumbline/previousPoint/position
Title: position
Description: The position of lastPoint in two dimensions
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/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
/aircraft/<RegExp>/navigation/courseGreatCircle/previousPoint
Description: The point on earth the vessel's presently navigating from
Object value with properties
- type
- href
/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/courseGreatCircle/previousPoint/position
Title: position
Description: The position of lastPoint in two dimensions
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/aircraft/<RegExp>/navigation/closestApproach
Description: Calculated values for other vessels, e.g. from AIS
Object value with properties
- distance (m)
- timeTo (s)
/aircraft/<RegExp>/navigation/racing
Description: Specific navigational data related to yacht racing.
/aircraft/<RegExp>/navigation/racing/startLineStb
Title: position
Description: Position of starboard start mark
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/aircraft/<RegExp>/navigation/racing/startLinePort
Title: position
Description: Position of port start mark
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/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/layline
Description: The layline crossing the current course
/aircraft/<RegExp>/navigation/racing/layline/distance
Units: m (Meter)
Description: The current distance to the layline
/aircraft/<RegExp>/navigation/racing/layline/time
Units: s (Second)
Description: The time to the layline at current speed and heading
/aircraft/<RegExp>/navigation/racing/oppositeLayline
Description: The layline parallell to current course
/aircraft/<RegExp>/navigation/racing/oppositeLayline/distance
Units: m (Meter)
Description: The current distance to the layline
/aircraft/<RegExp>/navigation/racing/oppositeLayline/time
Units: s (Second)
Description: The time to the layline at current speed and heading
/aircraft/<RegExp>/navigation/magneticVariation
Units: rad (Radian)
Description: The magnetic variation (declination) at the current position that must be added to the magnetic heading to derive the true heading. Easterly variations are positive and Westerly variations are negative (in Radians).
/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, equals 'headingCompass adjusted for magneticDeviation'
/aircraft/<RegExp>/navigation/magneticDeviation
Units: rad (Radian)
Description: Magnetic deviation of the compass at the current headingCompass
/aircraft/<RegExp>/navigation/headingCompass
Units: rad (Radian)
Description: Current magnetic heading received from the compass. This is not adjusted for magneticDeviation of the compass
/aircraft/<RegExp>/navigation/headingTrue
Units: rad (Radian)
Description: The current true north heading of the vessel, equals 'headingMagnetic adjusted for magneticVariation'
/aircraft/<RegExp>/navigation/position
Title: position
Description: The position of the vessel in 2 or 3 dimensions (WGS84 datum)
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/aircraft/<RegExp>/navigation/attitude
Title: Attitude
Description: Vessel attitude: roll, pitch and yaw
Object value with properties
- roll (rad)
- pitch (rad)
- yaw (rad)
/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
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/aircraft/<RegExp>/navigation/datetime
Description: Time and Date from the GNSS Positioning System
/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: Data should be of type number.
/aircraft/<RegExp>/design/aisShipType
Description: The ais ship type see http://www.bosunsmate.org/ais/message5.php
Object value with properties
- id
- name
/aircraft/<RegExp>/design/draft
Title: draft
Description: The draft of the vessel
Object value with properties
- minimum (m)
- maximum (m)
- current (m)
- canoe (m)
/aircraft/<RegExp>/design/length
Title: length
Description: The various lengths of the vessel
Object value with properties
- overall (m)
- hull (m)
- waterline (m)
/aircraft/<RegExp>/design/keel
Title: keel
Description: Information about the vessel's keel
/aircraft/<RegExp>/design/keel/angle
Units: rad (Radian)
Description: Data should be of type number.
/aircraft/<RegExp>/design/keel/lift
Units: ratio (Ratio)
Description: Data should be of type number.
/aircraft/<RegExp>/design/beam
Units: m (Meter)
Description: Data should be of type number.
/aircraft/<RegExp>/design/airHeight
Units: m (Meter)
Description: Data should be of type number.
/aircraft/<RegExp>/design/rigging
Title: rigging
Description: Information about the vessel's rigging
/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: Data should be of type number.
/aircraft/<RegExp>/sensors/<RegExp>/fromCenter
Description: Data should be of type number.
/aircraft/<RegExp>/sensors/<RegExp>/class
Description: AIS transponder class in sensors.ais.class, A or B
/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: The aton type
Object value with properties
- id
- name
/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: DEPRECATED: use relativeHumidity
/aton/<RegExp>/environment/outside/relativeHumidity
Units: ratio (Ratio)
Description: Current outside air relative humidity
/aton/<RegExp>/environment/outside/airDensity
Units: kg/m3 (undefined)
Description: Current outside air density
/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: Temperature
/aton/<RegExp>/environment/inside/heatIndexTemperature
Units: K (Kelvin)
Description: Current heat index temperature in zone
/aton/<RegExp>/environment/inside/pressure
Units: Pa (Pascal)
Description: Pressure in zone
/aton/<RegExp>/environment/inside/relativeHumidity
Units: ratio (Ratio)
Description: Relative humidity in zone
/aton/<RegExp>/environment/inside/dewPoint
Units: K (Kelvin)
Description: DEPRECATED: use dewPointTemperature
/aton/<RegExp>/environment/inside/dewPointTemperature
Units: K (Kelvin)
Description: Dewpoint in zone
/aton/<RegExp>/environment/inside/airDensity
Units: kg/m3 (undefined)
Description: Air density in zone
/aton/<RegExp>/environment/inside/illuminance
Units: Lux (undefined)
Description: Illuminance in zone
/aton/<RegExp>/environment/inside/[A-Za-z0-9]+
Description: This regex pattern is used for validation of the identifier for the environmental zone, eg. engineRoom, mainCabin, refrigerator
/aton/<RegExp>/environment/inside/[A-Za-z0-9]+/temperature
Units: K (Kelvin)
Description: Temperature
/aton/<RegExp>/environment/inside/[A-Za-z0-9]+/heatIndexTemperature
Units: K (Kelvin)
Description: Current heat index temperature in zone
/aton/<RegExp>/environment/inside/[A-Za-z0-9]+/pressure
Units: Pa (Pascal)
Description: Pressure in zone
/aton/<RegExp>/environment/inside/[A-Za-z0-9]+/relativeHumidity
Units: ratio (Ratio)
Description: Relative humidity in zone
/aton/<RegExp>/environment/inside/[A-Za-z0-9]+/dewPoint
Units: K (Kelvin)
Description: DEPRECATED: use dewPointTemperature
/aton/<RegExp>/environment/inside/[A-Za-z0-9]+/dewPointTemperature
Units: K (Kelvin)
Description: Dewpoint in zone
/aton/<RegExp>/environment/inside/[A-Za-z0-9]+/airDensity
Units: kg/m3 (undefined)
Description: Air density in zone
/aton/<RegExp>/environment/inside/[A-Za-z0-9]+/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
Object value with properties
- drift (m/s)
- setTrue (rad)
- setMagnetic (rad)
/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: RFC 3339 (UTC only without local offset) string representing date and time.
/aton/<RegExp>/environment/tide/timeHigh
Units: RFC 3339 (UTC) (undefined)
Description: RFC 3339 (UTC only without local offset) string representing date and time.
/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)
/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
/aton/<RegExp>/navigation/courseRhumbline/previousPoint
Description: The point on earth the vessel's presently navigating from
Object value with properties
- type
- href
/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/courseRhumbline/previousPoint/position
Title: position
Description: The position of lastPoint in two dimensions
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/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
/aton/<RegExp>/navigation/courseGreatCircle/previousPoint
Description: The point on earth the vessel's presently navigating from
Object value with properties
- type
- href
/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/courseGreatCircle/previousPoint/position
Title: position
Description: The position of lastPoint in two dimensions
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/aton/<RegExp>/navigation/closestApproach
Description: Calculated values for other vessels, e.g. from AIS
Object value with properties
- distance (m)
- timeTo (s)
/aton/<RegExp>/navigation/racing
Description: Specific navigational data related to yacht racing.
/aton/<RegExp>/navigation/racing/startLineStb
Title: position
Description: Position of starboard start mark
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/aton/<RegExp>/navigation/racing/startLinePort
Title: position
Description: Position of port start mark
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/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/layline
Description: The layline crossing the current course
/aton/<RegExp>/navigation/racing/layline/distance
Units: m (Meter)
Description: The current distance to the layline
/aton/<RegExp>/navigation/racing/layline/time
Units: s (Second)
Description: The time to the layline at current speed and heading
/aton/<RegExp>/navigation/racing/oppositeLayline
Description: The layline parallell to current course
/aton/<RegExp>/navigation/racing/oppositeLayline/distance
Units: m (Meter)
Description: The current distance to the layline
/aton/<RegExp>/navigation/racing/oppositeLayline/time
Units: s (Second)
Description: The time to the layline at current speed and heading
/aton/<RegExp>/navigation/magneticVariation
Units: rad (Radian)
Description: The magnetic variation (declination) at the current position that must be added to the magnetic heading to derive the true heading. Easterly variations are positive and Westerly variations are negative (in Radians).
/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, equals 'headingCompass adjusted for magneticDeviation'
/aton/<RegExp>/navigation/magneticDeviation
Units: rad (Radian)
Description: Magnetic deviation of the compass at the current headingCompass
/aton/<RegExp>/navigation/headingCompass
Units: rad (Radian)
Description: Current magnetic heading received from the compass. This is not adjusted for magneticDeviation of the compass
/aton/<RegExp>/navigation/headingTrue
Units: rad (Radian)
Description: The current true north heading of the vessel, equals 'headingMagnetic adjusted for magneticVariation'
/aton/<RegExp>/navigation/position
Title: position
Description: The position of the vessel in 2 or 3 dimensions (WGS84 datum)
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/aton/<RegExp>/navigation/attitude
Title: Attitude
Description: Vessel attitude: roll, pitch and yaw
Object value with properties
- roll (rad)
- pitch (rad)
- yaw (rad)
/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
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/aton/<RegExp>/navigation/datetime
Description: Time and Date from the GNSS Positioning System
/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: Data should be of type number.
/aton/<RegExp>/design/aisShipType
Description: The ais ship type see http://www.bosunsmate.org/ais/message5.php
Object value with properties
- id
- name
/aton/<RegExp>/design/draft
Title: draft
Description: The draft of the vessel
Object value with properties
- minimum (m)
- maximum (m)
- current (m)
- canoe (m)
/aton/<RegExp>/design/length
Title: length
Description: The various lengths of the vessel
Object value with properties
- overall (m)
- hull (m)
- waterline (m)
/aton/<RegExp>/design/keel
Title: keel
Description: Information about the vessel's keel
/aton/<RegExp>/design/keel/angle
Units: rad (Radian)
Description: Data should be of type number.
/aton/<RegExp>/design/keel/lift
Units: ratio (Ratio)
Description: Data should be of type number.
/aton/<RegExp>/design/beam
Units: m (Meter)
Description: Data should be of type number.
/aton/<RegExp>/design/airHeight
Units: m (Meter)
Description: Data should be of type number.
/aton/<RegExp>/design/rigging
Title: rigging
Description: Information about the vessel's rigging
/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: Data should be of type number.
/aton/<RegExp>/sensors/<RegExp>/fromCenter
Description: Data should be of type number.
/aton/<RegExp>/sensors/<RegExp>/class
Description: AIS transponder class in sensors.ais.class, A or B
/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
/sar/<RegExp>/navigation/courseRhumbline/previousPoint
Description: The point on earth the vessel's presently navigating from
Object value with properties
- type
- href
/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/courseRhumbline/previousPoint/position
Title: position
Description: The position of lastPoint in two dimensions
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/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
/sar/<RegExp>/navigation/courseGreatCircle/previousPoint
Description: The point on earth the vessel's presently navigating from
Object value with properties
- type
- href
/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/courseGreatCircle/previousPoint/position
Title: position
Description: The position of lastPoint in two dimensions
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/sar/<RegExp>/navigation/closestApproach
Description: Calculated values for other vessels, e.g. from AIS
Object value with properties
- distance (m)
- timeTo (s)
/sar/<RegExp>/navigation/racing
Description: Specific navigational data related to yacht racing.
/sar/<RegExp>/navigation/racing/startLineStb
Title: position
Description: Position of starboard start mark
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/sar/<RegExp>/navigation/racing/startLinePort
Title: position
Description: Position of port start mark
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/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/layline
Description: The layline crossing the current course
/sar/<RegExp>/navigation/racing/layline/distance
Units: m (Meter)
Description: The current distance to the layline
/sar/<RegExp>/navigation/racing/layline/time
Units: s (Second)
Description: The time to the layline at current speed and heading
/sar/<RegExp>/navigation/racing/oppositeLayline
Description: The layline parallell to current course
/sar/<RegExp>/navigation/racing/oppositeLayline/distance
Units: m (Meter)
Description: The current distance to the layline
/sar/<RegExp>/navigation/racing/oppositeLayline/time
Units: s (Second)
Description: The time to the layline at current speed and heading
/sar/<RegExp>/navigation/magneticVariation
Units: rad (Radian)
Description: The magnetic variation (declination) at the current position that must be added to the magnetic heading to derive the true heading. Easterly variations are positive and Westerly variations are negative (in Radians).
/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, equals 'headingCompass adjusted for magneticDeviation'
/sar/<RegExp>/navigation/magneticDeviation
Units: rad (Radian)
Description: Magnetic deviation of the compass at the current headingCompass
/sar/<RegExp>/navigation/headingCompass
Units: rad (Radian)
Description: Current magnetic heading received from the compass. This is not adjusted for magneticDeviation of the compass
/sar/<RegExp>/navigation/headingTrue
Units: rad (Radian)
Description: The current true north heading of the vessel, equals 'headingMagnetic adjusted for magneticVariation'
/sar/<RegExp>/navigation/position
Title: position
Description: The position of the vessel in 2 or 3 dimensions (WGS84 datum)
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/sar/<RegExp>/navigation/attitude
Title: Attitude
Description: Vessel attitude: roll, pitch and yaw
Object value with properties
- roll (rad)
- pitch (rad)
- yaw (rad)
/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
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/sar/<RegExp>/navigation/datetime
Description: Time and Date from the GNSS Positioning System
/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
Object value with properties
- method
- state
- message
/sar/<RegExp>/notifications/fire
Description: Fire onboard
Object value with properties
- method
- state
- message
/sar/<RegExp>/notifications/sinking
Description: Vessel is sinking
Object value with properties
- method
- state
- message
/sar/<RegExp>/notifications/flooding
Description: Vessel is flooding
Object value with properties
- method
- state
- message
/sar/<RegExp>/notifications/collision
Description: In collision with another vessel or object
Object value with properties
- method
- state
- message
/sar/<RegExp>/notifications/grounding
Description: Vessel grounding
Object value with properties
- method
- state
- message
/sar/<RegExp>/notifications/listing
Description: Vessel is listing
Object value with properties
- method
- state
- message
/sar/<RegExp>/notifications/adrift
Description: Vessel is adrift
Object value with properties
- method
- state
- message
/sar/<RegExp>/notifications/piracy
Description: Under attack or danger from pirates
Object value with properties
- method
- state
- message
/sar/<RegExp>/notifications/abandon
Description: Abandon ship
Object value with properties
- method
- state
- message
/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
/resources/routes
Title: route
Description: A holder for routes, each named with a UUID
/resources/routes/<RegExp>
Description: A route, named with a UUID
/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
/resources/notes/<RegExp>/position
Title: position
Description: Position related to note. Alternative to region or geohash
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/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
/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
Object value with properties
- longitude (deg)
- latitude (deg)
- altitude (m)
/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.5.0.