/vessels

Description: A wrapper object for vessel objects, each describing vessels in range, including this vessel.


/vessels/<RegExp>

Title: vessel

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


/vessels/<RegExp>/url

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


/vessels/<RegExp>/mmsi

Description: MMSI number of the vessel, if available.


/vessels/<RegExp>/mothershipMmsi

Description: MMSI number of the mothership of this vessel, if available.


/vessels/<RegExp>/uuid

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


/vessels/<RegExp>/name

Description: The common name of the vessel


/vessels/<RegExp>/flag

Description: The country of ship registration, or flag state of the vessel


/vessels/<RegExp>/port

Description: The home port of the vessel


/vessels/<RegExp>/registrations

Description: The various registrations of the vessel.


/vessels/<RegExp>/registrations/imo

Description: The IMO number of the vessel.


/vessels/<RegExp>/registrations/national

Description: The national registration number of the vessel.


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

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


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

Description: The ISO 3166-2 country code.


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

Description: The registration code


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

Description: The registration description


/vessels/<RegExp>/registrations/local

Description: A local or state registration number of the vessel.


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

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


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

Description: The registration code


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

Description: The registration description


/vessels/<RegExp>/registrations/other

Description: Other registration or permits for the vessel.


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

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


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

Description: The registration code


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

Description: The registration description


/vessels/<RegExp>/communication

Title: communication

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


/vessels/<RegExp>/communication/callsignVhf

Description: Callsign for VHF communication


/vessels/<RegExp>/communication/callsignHf

Description: Callsign for HF communication


/vessels/<RegExp>/communication/phoneNumber

Description: Phone number of skipper


/vessels/<RegExp>/communication/emailHf

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


/vessels/<RegExp>/communication/email

Description: Regular email for the skipper


/vessels/<RegExp>/communication/satPhoneNumber

Description: Satellite phone number for vessel.


/vessels/<RegExp>/communication/skipperName

Description: Full name of the skipper of the vessel.


/vessels/<RegExp>/communication/crewNames

Description: Array with the names of the crew


/vessels/<RegExp>/environment

Title: environment

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


/vessels/<RegExp>/environment/outside

Description: Environmental conditions outside of the vessel's hull


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

Units: K (Kelvin)

Description: Current outside air temperature


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

Units: K (Kelvin)

Description: Current outside dew point temperature


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

Units: K (Kelvin)

Description: Current outside apparent wind chill temperature


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

Units: K (Kelvin)

Description: Current outside theoretical wind chill temperature


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

Units: K (Kelvin)

Description: Current outside heat index temperature


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

Units: Pa (Pascal)

Description: Current outside air ambient pressure


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

Units: ratio (Ratio)

Description: Current outside air relative humidity


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

Units: Lux (undefined)

Description: Current outside ambient light flux.


/vessels/<RegExp>/environment/inside

Description: Environmental conditions inside the vessel's hull


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

Units: K (Kelvin)

Description: Current inside air temperature


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

Units: ratio (Ratio)

Description: Current inside air relative humidity


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

Description: Current engine room air temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current main cabin air temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current refrigerator temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current freezer temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


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

Description: Current heating temperature


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

Units: K (Kelvin)

Description: Temperature


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

Units: Pa (Pascal)

Description: Pressure in zone


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

Units: ratio (Ratio)

Description: Relative humidity in zone


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

Units: K (Kelvin)

Description: Dewpoint in zone


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

Units: kg/m3 (undefined)

Description: Air density in zone


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

Units: Lux (undefined)

Description: Illuminance in zone


/vessels/<RegExp>/environment/water

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


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

Units: K (Kelvin)

Description: Current water temperature


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

Units: ratio (Ratio)

Description: Water salinity


/vessels/<RegExp>/environment/depth

Title: depth

Description: Depth related data


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

Units: m (Meter)

Description: Depth below keel


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

Units: m (Meter)

Description: Depth below Transducer


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

Units: m (Meter)

Description: Depth from surface


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

Units: m (Meter)

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


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

Units: m (Meter)

Description: Depth transducer is below the water surface


/vessels/<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)

/vessels/<RegExp>/environment/tide

Title: tide

Description: Tide data


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

Units: m (Meter)

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


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

Units: m (Meter)

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


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

Units: m (Meter)

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


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

Units: RFC 3339 (UTC) (undefined)

Description: Time of the next low tide in UTC


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

Units: RFC 3339 (UTC) (undefined)

Description: Time of next high tide in UTC


/vessels/<RegExp>/environment/heave

Units: m (Meter)

Description: Vertical movement of the vessel due to waves


/vessels/<RegExp>/environment/wind

Title: wind

Description: Wind data.


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

Units: rad (Radian)

Description: Apparent wind angle, negative to port


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

Units: rad (Radian)

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


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

Units: rad (Radian)

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


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

Units: rad (Radian)

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


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

Units: rad (Radian)

Description: The wind direction relative to true north


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

Units: rad (Radian)

Description: The wind direction relative to magnetic north


/vessels/<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)


/vessels/<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)


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

Units: m/s (Meters per second)

Description: Apparent wind speed


/vessels/<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))

/vessels/<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.


/vessels/<RegExp>/navigation

Title: navigation

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


/vessels/<RegExp>/navigation/lights

Title: Navigation lights

Description: Current state of the vessels navigation lights


/vessels/<RegExp>/navigation/courseOverGroundMagnetic

Units: rad (Radian)

Description: Course over ground (magnetic)


/vessels/<RegExp>/navigation/courseOverGroundTrue

Units: rad (Radian)

Description: Course over ground (true)


/vessels/<RegExp>/navigation/courseRhumbline

Title: Course

Description: Course information computed with Rhumbline


/vessels/<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).


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

Units: rad (Radian)

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


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

Units: rad (Radian)

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


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

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


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

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


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

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


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

Description: The time this route was activated


/vessels/<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

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

Units: m (Meter)

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


/vessels/<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


/vessels/<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


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

Units: m/s (Meters per second)

Description: The velocity component of the vessel towards the nextPoint


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

Units: s (Second)

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


/vessels/<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

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

Units: m (Meter)

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


/vessels/<RegExp>/navigation/courseGreatCircle

Title: Course

Description: Course information computed with Great Circle


/vessels/<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).


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

Units: rad (Radian)

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


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

Units: rad (Radian)

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


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

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


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

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


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

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


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

Description: The time this route was activated


/vessels/<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

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

Units: m (Meter)

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


/vessels/<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


/vessels/<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


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

Units: m/s (Meters per second)

Description: The velocity component of the vessel towards the nextPoint


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

Units: s (Second)

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


/vessels/<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

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

Units: m (Meter)

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


/vessels/<RegExp>/navigation/racing

Description: Specific navigational data related to yacht racing.


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

Description: Position of starboard start mark


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

Description: Position of starboard start mark


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

Units: m (Meter)

Description: The current distance to the start line


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

Units: s (Second)

Description: Time left before start


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

Units: s (Second)

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


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

Units: s (Second)

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


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

Units: s (Second)

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


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

Units: s (Second)

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


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

Units: m (Meter)

Description: The current distance to the layline


/vessels/<RegExp>/navigation/magneticVariation

Units: rad (Radian)

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


/vessels/<RegExp>/navigation/magneticVariationAgeOfService

Units: s (Second)

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


/vessels/<RegExp>/navigation/destination

Title: destination

Description: The intended destination of this trip


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

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


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

Description: Expected time of arrival at destination waypoint


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

Description: UUID of destination waypoint


/vessels/<RegExp>/navigation/gnss

Title: gnss

Description: Global satellite navigation meta information


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

Description: Fix type


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

Description: Quality of the satellite fix


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

Description: Integrity of the satellite fix


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

Description: Number of satellites


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

Units: m (Meter)

Description: Altitude of antenna


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

Description: Horizontal Dilution of Precision


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

Description: Positional Dilution of Precision


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

Description: Difference between WGS84 earth ellipsoid and mean sea level


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

Units: s (Second)

Description: Age of DGPS data


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

Description: ID of DGPS base station


/vessels/<RegExp>/navigation/headingMagnetic

Units: rad (Radian)

Description: Current magnetic heading of the vessel


/vessels/<RegExp>/navigation/headingTrue

Units: rad (Radian)

Description: The current true heading of the vessel


/vessels/<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)

/vessels/<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)

/vessels/<RegExp>/navigation/maneuver

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


/vessels/<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


/vessels/<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


/vessels/<RegExp>/navigation/speedThroughWater

Units: m/s (Meters per second)

Description: Vessel speed through the water


/vessels/<RegExp>/navigation/speedThroughWaterTransverse

Units: m/s (Meters per second)

Description: Transverse speed through the water (Leeway)


/vessels/<RegExp>/navigation/speedThroughWaterLongitudinal

Units: m/s (Meters per second)

Description: Longitudinal speed through the water


/vessels/<RegExp>/navigation/leewayAngle

Units: rad (Radian)

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


/vessels/<RegExp>/navigation/log

Units: m (Meter)

Description: Total distance traveled


/vessels/<RegExp>/navigation/trip

Description: Trip data


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

Units: m (Meter)

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


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

Description: Trip log reset time


/vessels/<RegExp>/navigation/state

Title: state

Description: Current navigational state of the vessel


/vessels/<RegExp>/navigation/anchor

Title: anchor

Description: The anchor data, for anchor watch etc


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

Units: m (Meter)

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


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

Units: m (Meter)

Description: Current distance to anchor


/vessels/<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)

/vessels/<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

/vessels/<RegExp>/propulsion

Title: propulsion

Description: Engine data, each engine identified by a unique name i.e. Port_Engine


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

Description: This regex pattern is used for validation of the identifier for the propulsion unit


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

Description: Human readable label for the propulsion unit


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

Description: The current state of the engine


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

Units: Hz (Hertz)

Description: Engine revolutions (x60 for RPM)


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

Units: K (Kelvin)

Description: Engine temperature


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

Units: K (Kelvin)

Description: Oil temperature


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

Units: Pa (Pascal)

Description: Oil pressure


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

Units: V (Volt)

Description: Alternator voltage


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

Units: s (Second)

Description: Total running time for engine (Engine Hours in seconds)


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

Units: K (Kelvin)

Description: Coolant temperature


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

Units: Pa (Pascal)

Description: Coolant pressure


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

Units: Pa (Pascal)

Description: Engine boost (turbo, supercharger) pressure


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

Units: ratio (Ratio)

Description: Engine load ratio, 0<=ratio<=1, 1 is 100%


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

Units: ratio (Ratio)

Description: Engine torque ratio, 0<=ratio<=1, 1 is 100%


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

Description: The transmission (gear box) of the named engine


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

Description: Currently selected gear the engine is in i.e. Forward, Reverse, etc.


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

Units: ratio (Ratio)

Description: Gear ratio, engine rotations per propeller shaft rotation


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

Units: K (Kelvin)

Description: Oil temperature


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

Units: Pa (Pascal)

Description: Oil pressure


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

Description: Data about the engine's drive.


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

Description: The type of drive the boat has i.e Outboard, shaft, jet, etc.

Enum values:

  • saildrive
  • shaft
  • outboard
  • jet
  • pod
  • other

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

Units: ratio (Ratio)

Description: Trim/tilt state, 0<=ratio<=1, 1 is 100% up


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

Units: rad (Radian)

Description: Current thrust angle for steerable drives, +ve is thrust to Starboard


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

Description: Data about the drive's propeller (pitch and slip)


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

Description: Data about the engine's Fuel Supply


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

Description: Fuel type

Enum values:

  • diesel
  • petrol
  • electric
  • coal/wood
  • other

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

Units: m3 (Cubic meter)

Description: Used fuel since last reset. Resetting is at user discretion


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

Units: Pa (Pascal)

Description: Fuel pressure


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

Units: m3/s (Cubic meter per second)

Description: Fuel rate of consumption


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

Units: m3/s (Cubic meter per second)

Description: Economy fuel rate of consumption


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

Units: m3/s (Cubic meter per second)

Description: Average fuel rate of consumption


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

Units: K (Kelvin)

Description: Exhaust temperature


/vessels/<RegExp>/electrical

Title: electrical

Description: Electrical data, each electrical device indentified by a unique name i.e. Battery_1


/vessels/<RegExp>/electrical/batteries

Description: Data about the vessel's batteries


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

Title: Battery keyed by instance id

Description: Batteries, one or many, within the vessel


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

Title: temperature

Description: Additional / unique temperatures associated with a battery

Fields:

  • limitDischargeLower (Operational minimum temperature limit for battery discharge), units: K (Kelvin)
  • limitDischargeUpper (Operational maximum temperature limit for battery discharge), units: K (Kelvin)
  • limitRechargeLower (Operational minimum temperature limit for battery recharging), units: K (Kelvin)
  • limitRechargeUpper (Operational maximum temperature limit for battery recharging), units: K (Kelvin)
  • warnUpper (Upper operational temperature limit), units: K (Kelvin)
  • warnLower (Lower operational temperature limit), units: K (Kelvin)
  • faultUpper (Upper fault temperature limit - device may disable/disconnect), units: K (Kelvin)
  • faultLower (Lower fault temperature limit - device may disable/disconnect), units: K (Kelvin)

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

Title: capacity

Description: Data about the battery's capacity


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

Units: J (Joule)

Description: The capacity of battery as specified by the manufacturer


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

Units: J (Joule)

Description: The measured capacity of battery. This may change over time and will likely deviate from the nominal capacity.


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

Units: J (Joule)

Description: Capacity remaining in battery


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

Units: J (Joule)

Description: Minimum capacity to be left in the battery while discharging


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

Units: ratio (Ratio)

Description: State of charge, 1 = 100%


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

Units: ratio (Ratio)

Description: State of Health, 1 = 100%


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

Units: C (Coulomb)

Description: Cumulative discharge since battery was last full


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

Units: s (Second)

Description: Time to discharge to discharge limit at current rate


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

Units: C (Coulomb)

Description: Cumulative charge discharged from battery over operational lifetime of battery


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

Units: C (Coulomb)

Description: Cumulative charge recharged into battery over operational lifetime of battery


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

Description: Name of BUS device is associated with


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

Units: V (Volt)

Description: Voltage measured as close as possible to the device


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

Units: V (Volt)

Description: DC Ripple voltage


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

Units: A (Ampere)

Description: Current flowing out (+ve) or in (-ve) to the device


/vessels/<RegExp>/electrical/inverters

Description: Data about the Inverter that has both DC and AC quantities


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

Title: Inverter

Description: DC to AC inverter, one or many, within the vessel


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

Title: DC Quantities

Description: DC common quantities


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

Description: Name of BUS device is associated with


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

Units: V (Volt)

Description: Voltage measured as close as possible to the device


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

Units: V (Volt)

Description: DC Ripple voltage


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

Units: A (Ampere)

Description: Current flowing out (+ve) or in (-ve) to the device


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

Title: temperature

Description: Temperature measured within or on the device

Fields:

  • warnUpper (Upper operational temperature limit), units: K (Kelvin)
  • warnLower (Lower operational temperature limit), units: K (Kelvin)
  • faultUpper (Upper fault temperature limit - device may disable/disconnect), units: K (Kelvin)
  • faultLower (Lower fault temperature limit - device may disable/disconnect), units: K (Kelvin)

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

Title: AC Quantities

Description: AC equipment common quantities


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

Description: Name of BUS source is assocated with (if applicable, may = NULL)


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

Units: V (Volt)

Description: RMS voltage measured between phase and neutral.


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

Units: V (Volt)

Description: RMS voltage measured between phases


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

Units: A (Ampere)

Description: RMS current


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

Units: Hz (Hertz)

Description: AC frequency.


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

Units: W (Watt)

Description: Reactive power


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

Description: Power factor


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

Description: Lead/lag status.

Enum values:

  • leading
  • lagging
  • error
  • not available

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

Units: W (Watt)

Description: Real power.


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

Units: W (Watt)

Description: Apparent power.


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

Description: Mode of inverter


/vessels/<RegExp>/electrical/chargers

Description: Data about the Charger that has both DC and AC quantities


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

Title: Charger

Description: Battery charger


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

Description: Name of BUS device is associated with


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

Units: V (Volt)

Description: Voltage measured as close as possible to the device


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

Units: V (Volt)

Description: DC Ripple voltage


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

Units: A (Ampere)

Description: Current flowing out (+ve) or in (-ve) to the device


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

Title: temperature

Description: Temperature measured within or on the device

Fields:

  • warnUpper (Upper operational temperature limit), units: K (Kelvin)
  • warnLower (Lower operational temperature limit), units: K (Kelvin)
  • faultUpper (Upper fault temperature limit - device may disable/disconnect), units: K (Kelvin)
  • faultLower (Lower fault temperature limit - device may disable/disconnect), units: K (Kelvin)

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

Description: Charging mode i.e. float, overcharge, etc.


/vessels/<RegExp>/electrical/ac

Description: AC buses


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

Title: AC Bus keyed by instance id

Description: AC Bus, one or many, within the vessel


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

Description: Single or A,B or C in 3 Phase systems


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

Title: AC Quantities

Description: AC equipment common quantities


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

Description: Name of BUS source is assocated with (if applicable, may = NULL)


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

Units: V (Volt)

Description: RMS voltage measured between phase and neutral.


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

Units: V (Volt)

Description: RMS voltage measured between phases


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

Units: A (Ampere)

Description: RMS current


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

Units: Hz (Hertz)

Description: AC frequency.


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

Units: W (Watt)

Description: Reactive power


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

Description: Power factor


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

Description: Lead/lag status.

Enum values:

  • leading
  • lagging
  • error
  • not available

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

Units: W (Watt)

Description: Real power.


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

Units: W (Watt)

Description: Apparent power.


/vessels/<RegExp>/notifications

Title: notifications

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


/vessels/<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)


/vessels/<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)


/vessels/<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)


/vessels/<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)


/vessels/<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)


/vessels/<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)


/vessels/<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)


/vessels/<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)


/vessels/<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)


/vessels/<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)


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

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


/vessels/<RegExp>/steering

Title: steering

Description: Vessel steering data for steering controls (not Autopilot 'Nav Data')


/vessels/<RegExp>/steering/rudderAngle

Units: rad (Radian)

Description: Current rudder angle, +ve is rudder to Starboard


/vessels/<RegExp>/steering/rudderAngleTarget

Units: rad (Radian)

Description: The angle the rudder should move to, +ve is rudder to Starboard


/vessels/<RegExp>/steering/autopilot

Title: autopilot

Description: Autopilot data


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

Description: Autopilot state


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

Description: Operational mode


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

Title: target

Description: Autopilot target


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

Units: rad (Radian)

Description: Target angle to steer, relative to Apparent wind +port -starboard


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

Units: rad (Radian)

Description: Target heading for autopilot, relative to North


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

Units: rad (Radian)

Description: Target heading for autopilot, relative to Magnetic North


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

Units: rad (Radian)

Description: Dead zone to ignore for rudder corrections


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

Units: rad (Radian)

Description: Slack in the rudder drive mechanism


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

Description: Auto-pilot gain, higher number equals more rudder movement for a given turn


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

Units: A (Ampere)

Description: Maximum current to use to drive servo


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

Units: rad/s (Radian per second)

Description: Maximum rudder rotation speed


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

Units: rad (Radian)

Description: Position of servo on port lock


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

Units: rad (Radian)

Description: Position of servo on starboard lock


/vessels/<RegExp>/tanks

Title: tanks

Description: Tank data, each tank indentified by a unique name i.e. FreshWater_2


/vessels/<RegExp>/tanks/freshWater

Description: Fresh water tank (drinking)


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

Description: Tank, one or many, within the vessel


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

Description: The name of the tank. Useful if multiple tanks of a certain type are on board


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

Description: The type of tank

Enum values:

  • petrol
  • fresh water
  • greywater
  • blackwater
  • holding
  • lpg
  • diesel
  • liveWell
  • ballast
  • rum

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

Units: m3 (Cubic meter)

Description: Total capacity


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

Units: ratio (Ratio)

Description: Level of fluid in tank 0-100%


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

Units: m3 (Cubic meter)

Description: Volume of fluid in tank


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

Units: Pa (Pascal)

Description: Pressure of contents in tank, especially LPG/gas


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

Units: K (Kelvin)

Description: Temperature of tank, especially cryogenic or LPG/gas


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

Units: Pa/s (undefined)

Description: Viscosity of the fluid, if applicable


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

Description: The preferred extinguishant to douse a fire in this tank


/vessels/<RegExp>/tanks/wasteWater

Description: Waste water tank (grey water)


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

Description: Tank, one or many, within the vessel


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

Description: The name of the tank. Useful if multiple tanks of a certain type are on board


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

Description: The type of tank

Enum values:

  • petrol
  • fresh water
  • greywater
  • blackwater
  • holding
  • lpg
  • diesel
  • liveWell
  • ballast
  • rum

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

Units: m3 (Cubic meter)

Description: Total capacity


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

Units: ratio (Ratio)

Description: Level of fluid in tank 0-100%


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

Units: m3 (Cubic meter)

Description: Volume of fluid in tank


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

Units: Pa (Pascal)

Description: Pressure of contents in tank, especially LPG/gas


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

Units: K (Kelvin)

Description: Temperature of tank, especially cryogenic or LPG/gas


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

Units: Pa/s (undefined)

Description: Viscosity of the fluid, if applicable


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

Description: The preferred extinguishant to douse a fire in this tank


/vessels/<RegExp>/tanks/blackWater

Description: Black water tank (sewage)


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

Description: Tank, one or many, within the vessel


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

Description: The name of the tank. Useful if multiple tanks of a certain type are on board


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

Description: The type of tank

Enum values:

  • petrol
  • fresh water
  • greywater
  • blackwater
  • holding
  • lpg
  • diesel
  • liveWell
  • ballast
  • rum

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

Units: m3 (Cubic meter)

Description: Total capacity


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

Units: ratio (Ratio)

Description: Level of fluid in tank 0-100%


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

Units: m3 (Cubic meter)

Description: Volume of fluid in tank


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

Units: Pa (Pascal)

Description: Pressure of contents in tank, especially LPG/gas


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

Units: K (Kelvin)

Description: Temperature of tank, especially cryogenic or LPG/gas


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

Units: Pa/s (undefined)

Description: Viscosity of the fluid, if applicable


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

Description: The preferred extinguishant to douse a fire in this tank


/vessels/<RegExp>/tanks/fuel

Description: Fuel tank (petrol or diesel)


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

Description: Tank, one or many, within the vessel


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

Description: The name of the tank. Useful if multiple tanks of a certain type are on board


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

Description: The type of tank

Enum values:

  • petrol
  • fresh water
  • greywater
  • blackwater
  • holding
  • lpg
  • diesel
  • liveWell
  • ballast
  • rum

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

Units: m3 (Cubic meter)

Description: Total capacity


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

Units: ratio (Ratio)

Description: Level of fluid in tank 0-100%


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

Units: m3 (Cubic meter)

Description: Volume of fluid in tank


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

Units: Pa (Pascal)

Description: Pressure of contents in tank, especially LPG/gas


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

Units: K (Kelvin)

Description: Temperature of tank, especially cryogenic or LPG/gas


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

Units: Pa/s (undefined)

Description: Viscosity of the fluid, if applicable


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

Description: The preferred extinguishant to douse a fire in this tank


/vessels/<RegExp>/tanks/lubrication

Description: Lubrication tank (oil or grease)


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

Description: Tank, one or many, within the vessel


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

Description: The name of the tank. Useful if multiple tanks of a certain type are on board


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

Description: The type of tank

Enum values:

  • petrol
  • fresh water
  • greywater
  • blackwater
  • holding
  • lpg
  • diesel
  • liveWell
  • ballast
  • rum

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

Units: m3 (Cubic meter)

Description: Total capacity


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

Units: ratio (Ratio)

Description: Level of fluid in tank 0-100%


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

Units: m3 (Cubic meter)

Description: Volume of fluid in tank


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

Units: Pa (Pascal)

Description: Pressure of contents in tank, especially LPG/gas


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

Units: K (Kelvin)

Description: Temperature of tank, especially cryogenic or LPG/gas


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

Units: Pa/s (undefined)

Description: Viscosity of the fluid, if applicable


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

Description: The preferred extinguishant to douse a fire in this tank


/vessels/<RegExp>/tanks/liveWell

Description: Live tank (fish)


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

Description: Tank, one or many, within the vessel


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

Description: The name of the tank. Useful if multiple tanks of a certain type are on board


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

Description: The type of tank

Enum values:

  • petrol
  • fresh water
  • greywater
  • blackwater
  • holding
  • lpg
  • diesel
  • liveWell
  • ballast
  • rum

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

Units: m3 (Cubic meter)

Description: Total capacity


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

Units: ratio (Ratio)

Description: Level of fluid in tank 0-100%


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

Units: m3 (Cubic meter)

Description: Volume of fluid in tank


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

Units: Pa (Pascal)

Description: Pressure of contents in tank, especially LPG/gas


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

Units: K (Kelvin)

Description: Temperature of tank, especially cryogenic or LPG/gas


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

Units: Pa/s (undefined)

Description: Viscosity of the fluid, if applicable


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

Description: The preferred extinguishant to douse a fire in this tank


/vessels/<RegExp>/tanks/gas

Description: Lpg/propane and other gases


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

Description: Tank, one or many, within the vessel


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

Description: The name of the tank. Useful if multiple tanks of a certain type are on board


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

Description: The type of tank

Enum values:

  • petrol
  • fresh water
  • greywater
  • blackwater
  • holding
  • lpg
  • diesel
  • liveWell
  • ballast
  • rum

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

Units: m3 (Cubic meter)

Description: Total capacity


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

Units: ratio (Ratio)

Description: Level of fluid in tank 0-100%


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

Units: m3 (Cubic meter)

Description: Volume of fluid in tank


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

Units: Pa (Pascal)

Description: Pressure of contents in tank, especially LPG/gas


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

Units: K (Kelvin)

Description: Temperature of tank, especially cryogenic or LPG/gas


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

Units: Pa/s (undefined)

Description: Viscosity of the fluid, if applicable


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

Description: The preferred extinguishant to douse a fire in this tank


/vessels/<RegExp>/tanks/ballast

Description: Ballast tanks


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

Description: Tank, one or many, within the vessel


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

Description: The name of the tank. Useful if multiple tanks of a certain type are on board


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

Description: The type of tank

Enum values:

  • petrol
  • fresh water
  • greywater
  • blackwater
  • holding
  • lpg
  • diesel
  • liveWell
  • ballast
  • rum

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

Units: m3 (Cubic meter)

Description: Total capacity


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

Units: ratio (Ratio)

Description: Level of fluid in tank 0-100%


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

Units: m3 (Cubic meter)

Description: Volume of fluid in tank


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

Units: Pa (Pascal)

Description: Pressure of contents in tank, especially LPG/gas


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

Units: K (Kelvin)

Description: Temperature of tank, especially cryogenic or LPG/gas


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

Units: Pa/s (undefined)

Description: Viscosity of the fluid, if applicable


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

Description: The preferred extinguishant to douse a fire in this tank


/vessels/<RegExp>/design

Title: design

Description: Design/dimensional data of this vessel


/vessels/<RegExp>/design/displacement

Units: kg (Kilogram)

Description: The displacement of the vessel


/vessels/<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

/vessels/<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)

/vessels/<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)

/vessels/<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

/vessels/<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.


/vessels/<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.


/vessels/<RegExp>/design/beam

Units: m (Meter)

Description: Beam length


/vessels/<RegExp>/design/airHeight

Units: m (Meter)

Description: Total height of the vessel


/vessels/<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.)

/vessels/<RegExp>/sails

Title: sails

Description: Sails data


/vessels/<RegExp>/sails/inventory

Description: An object containing a description of each sail available to the vessel crew


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

Description: 'sail' data type.

Fields:

  • name (An unique identifier by which the crew identifies a sail)
  • type (The type of sail)
  • material (The material the sail is made from (optional))
  • brand (The brand of the sail (optional))
  • active (Indicates wether this sail is currently in use or not)
  • area (The total area of this sail in square meters), units: m2 (Square meter)
  • minimumWind (The minimum wind speed this sail can be used with), units: m/s (Meters per second)
  • maximumWind (The maximum wind speed this sail can be used with), units: m/s (Meters per second)

/vessels/<RegExp>/sails/area

Description: An object containing information about the vessels' sails.


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

Units: m2 (Square meter)

Description: The total area of all sails on the vessel


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

Units: m2 (Square meter)

Description: The total area of the sails currently in use on the vessel


/vessels/<RegExp>/sensors

Title: sensors

Description: Sensors, their state, and data.


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

Title: sensor

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


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

Description: The common name of the sensor


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

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


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

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


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

Description: The distance from the bow to the sensor location


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

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


/vessels/<RegExp>/performance

Title: performance

Description: Performance Sailing data including VMG, Polar Speed, tack angle, etc.


/vessels/<RegExp>/performance/polarSpeed

Units: m/s (Meters per second)

Description: The current polar speed based on current polar diagram, trueWindSpeed and truewindAngle.


/vessels/<RegExp>/performance/polarSpeedRatio

Units: ratio (Ratio)

Description: The ratio of current speed through water to the polar speed.


/vessels/<RegExp>/performance/velocityMadeGood

Units: m/s (Meters per second)

Description: The current velocity made good derived from the speed through water and appearant wind angle. A positive value is heading to upwind, negative to downwind.


/vessels/<RegExp>/performance/velocityMadeGoodToWaypoint

Units: m/s (Meters per second)

Description: The current velocity made good to the next waypoint derived from the speedOverGround, courseOverGround.


/vessels/<RegExp>/performance/beatAngle

Units: rad (Radian)

Description: The true wind beat angle for the best velocity made good based on current current polar diagram and trueWindSpeed.


/vessels/<RegExp>/performance/beatAngleVelocityMadeGood

Units: m/s (Meters per second)

Description: The velocity made good for the beat angle.


/vessels/<RegExp>/performance/beatAngleTargetSpeed

Units: m/s (Meters per second)

Description: The target speed for the beat angle.


/vessels/<RegExp>/performance/gybeAngle

Units: rad (Radian)

Description: The true wind gybe angle for the best velocity made good downwind based on current polar diagram and trueWindSpeed.


/vessels/<RegExp>/performance/gybeAngleVelocityMadeGood

Units: m/s (Meters per second)

Description: The velocity made good for the gybe angle


/vessels/<RegExp>/performance/gybeAngleTargetSpeed

Units: m/s (Meters per second)

Description: The target speed for the gybe angle.


/vessels/<RegExp>/performance/targetAngle

Units: rad (Radian)

Description: The true wind gybe or beat angle for the best velocity made good downwind or upwind based on current polar diagram and trueWindSpeed.


/vessels/<RegExp>/performance/targetSpeed

Units: m/s (Meters per second)

Description: The target speed for the beat angle or gybe angle, which ever is applicable.


/vessels/<RegExp>/performance/leeway

Units: rad (Radian)

Description: Current leeway


/vessels/<RegExp>/performance/tackMagnetic

Units: rad (Radian)

Description: Magnetic heading on opposite tack.


/vessels/<RegExp>/performance/tackTrue

Units: rad (Radian)

Description: True heading on opposite tack.


results matching ""

    No results matching ""