Skip to content

Instantly share code, notes, and snippets.

@fabdrol
Last active September 15, 2016 19:30
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save fabdrol/9d615d0c80637a9b34e4c69a5bab9208 to your computer and use it in GitHub Desktop.
Save fabdrol/9d615d0c80637a9b34e4c69a5bab9208 to your computer and use it in GitHub Desktop.

Signal K Data Model Reference

This document is meant as the human-oriented reference to accompany the actual JSON Schema specification and is produced from the schema files. Any changes to the reference material below should be made to the original schema files.

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


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


Title: vessel

Description: An object describing an individual vessel. It should be an object in vessels, named using MMSI or a UUID


Description: A location of a resource, potentially relative. For hierarchical schemes (like http), applications must resolve relative URIs (e.g. './v1/api/'). Implementations should support the following schemes: http:, https:, mailto:, tel:, and ws:.


Description: Maritime Mobile Service Identity (MMSI). Has to be 9 digits. See http://en.wikipedia.org/wiki/Maritime_Mobile_Service_Identity for information.


Description: A unique Signal K flavoured maritime resource identifier (MRN). A MRN is a form of URN, following a specific format: urn:mrn:::. In case of a Signal K uuid, that looks like this: urn:mrn:signalk:uuid:, where Signal K is the issuing authority and UUID (v4) the ID type.


Description: The common name of the vessel


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


Description: The home port of the vessel


Description: The various registrations of the vessel.


Description: The IMO number of the vessel.


Description: The national registration number of the vessel.


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


Description: The ISO 3166-2 country code.


Description: The registration code


Description: The registration description


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


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


Description: The registration code


Description: The registration description


Description: Other registration or permits for the vessel.


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


Description: The registration code


Description: The registration description


Title: communication

Description: Schema describing the communication child-object of a Vessel.


Description: Callsign for VHF communication


Description: Callsign for HF communication


Description: Phone number of skipper


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


Description: Regular email for the skipper


Description: Satellite phone number for vessel.


Description: Full name of the skipper of the vessel.


Description: Array with the names of the crew


Title: environment

Description: Schema describing the environmental child-object of a Vessel.


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Title: depth

Description: Depth related data


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Units: m/s

Description: The speed component of the water current vector


Units: rad

Description: The direction component of the water current vector referenced to true (geographic) north


Units: rad

Description: The direction component of the water current vector referenced to magnetic north


Title: tide

Description: Tide data


Description: [missing]


Description: [missing]


Description: [missing]


Units: ISO-8601 (UTC)

Description: ISO-8601 (UTC) string representing date and time.


Units: ISO-8601 (UTC)

Description: ISO-8601 (UTC) string representing date and time.


Description: [missing]


Title: wind

Description: Wind data.


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: A time reference onboard.


Title: Epoch time

Description: Milliseconds since the UNIX epoch (1970-01-01 00:00:00)


Title: Timezone offset

Description: Timezone offset in hours and minutes (-)hhmm


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


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.


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Title: navigation

Description: Schema describing the navigation child-object of a Vessel.


Title: Navigation lights

Description: Current state of the vessels navigation lights


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Title: destination

Description: The intended destination of this trip


Units: ISO-8601 (UTC)

Description: ISO-8601 (UTC) string representing date and time.


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Description: UUID of destination waypoint


Title: gnss

Description: Global satellite navigation meta information


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Description: Quality of the satellite fix


Description: Integrity of the satellite fix


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Title: position

Description: The position in 3 dimensions


Units: deg

Description: Longitude


Units: deg

Description: Latitude


Units: m

Description: Altitude


Description: [missing]


Units: rad

Description: Vessel roll, +ve is list to starboard


Units: rad

Description: Pitch, +ve is bow up


Units: rad

Description: Yaw, +ve is heading change to starboard


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Title: state

Description: Current navigational state of the vessel


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Title: anchor

Description: The anchor data, for anchor watch etc


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Description: [missing]


Description: [missing]


Title: position

Description: The position in 3 dimensions


Units: deg

Description: Longitude


Units: deg

Description: Latitude


Units: m

Description: Altitude


Description: [missing]


Description: Source of GNSS Date and Time


Title: propulsion

Description: An engine, named by a unique name within this vessel


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


Description: Human readable label for the propulsion unit


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: Fuel type


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Title: Electrical Properties

Description: Schema describing the electrical child-object of a Vessel.


Description: [missing]


Description: [missing]


Title: temperature

Description: Additional / unique temperatures associated with a battery


Units: K

Description: Operational minimum temperature limit for battery discharge, in degrees Celsius


Units: K

Description: Operational maximum temperature limit for battery discharge, in degrees Celsius


Units: K

Description: Operational minimum temperature limit for battery recharging, in degrees Celsius


Units: K

Description: Operational maximum temperature limit for battery recharging, in degrees Celsius


Title: capacity

Description: [missing]


Units: J

Description: The capacity of battery as specified by the manufacturer


Units: J

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


Units: J

Description: Capacity remaining in battery


Units: J

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


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Units: C

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


Units: C

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


Description: [missing]


Title: Inverter

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


Description: [missing]


Description: [missing]


Description: Mode of inverter


Description: [missing]


Description: [missing]


Description: [missing]


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Description: AC buses


Title: AC bus

Description: [missing]


Description: [missing]


Description: [missing]


Title: notifications

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


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: notifications

Description: Notifications, their state, and actions. The notification limits are set in any Signal K key.meta.zones array.


Description: Reference to the source under vessel's sources. A dot spearated path to the data. eg [type].[bus].[device]


Title: steering

Description: Schema describing the steering child-object of a vessel.


Description: [missing]


Description: [missing]


Title: autopilot

Description: Autopilot data


Description: Autopilot state


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Description: Operational mode


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Description: [missing]


Description: [missing]


Description: Current source of heading information


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: A tank, named by a unique identifier


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Title: design

Description: An object describing the vessels primary dimensions and statistics.


Description: [missing]


Title: draft

Description: The draft of the vessel


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Units: m

Description: The minimum draft of the vessel


Units: m

Description: The maximum draft of the vessel


Units: m

Description: The draft of the vessel without protrusions such as keel, centerboard, rudder


Title: length

Description: The various lengths of the vessel


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Units: m

Description: Length overall


Units: m

Description: Length of hull


Units: m

Description: Length at waterline


Title: keel

Description: Information about the vessel's keel


Description: The type of keel.


Description: [missing]


Description: [missing]


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Description: [missing]


Description: [missing]


Title: rigging

Description: Information about the vessel's rigging


Description: The configuration of the rigging


Description: The number of masts on the vessel.


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Title: sails

Description: An object describing the vessels sails if the vessel is a sailboat.


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


Description: 'sail' data type.


Description: An unique identifier by which the crew identifies a sail


Description: The type of sail


Description: The material the sail is made from (optional)


Description: The brand of the sail (optional)


Description: Indicates wether this sail is currently in use or not


Units: m2

Description: The total area of this sail in square meters


Units: m/s

Description: The minimum wind speed this sail can be used with


Units: m/s

Description: The maximum wind speed this sail can be used with


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


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


Description: [missing]


Description: [missing]


Title: sensors

Description: Sensors, their state, and data.


Title: sensor

Description: An object describing an individual sensor. It should be an object in vessel, named using a unique name or UUID


Description: The common name of the sensor


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


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


Description: [missing]


Description: [missing]


Title: performance

Description: Schema describing the performance child-object of a Vessel.


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Description: [missing]


Title: sources

Description: Metadata about the sources, eg. buses and connected sensors


Description: [missing]


Description: Sources unique name e.g. [type-bus].[id], N2000-01.034


Description: Type of interface i.e. signalk, NMEA0183 or NMEA2000


Description: Manufacturer of the source device


Description: NMEA2000 Product Function Code


Description: NMEA2000 Product Class Code


Description: NMEA2000 Product Code


Description: Product Name or Model Number


Description: Version of the device's Software/Firmware


Description: Version of the device's Hardware


Description: Device's Serial Number


Description: Product Installation Note 1 i.e. 'Wired on Navigation Switch/Circuit'


Description: Product Installation Note 2 i.e. 'Located under forward bunk'


Description: Manufacturer's Info i.e. 'http://digitalyachtamerica.com Tel:+44 1179 554474'


Description: [missing]


Title: resources

Description: Resources to aid in navigation and operation of the vessel


Title: chart

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


Description: A chart


Description: Chart common name


Description: Chart number


Description: A description of the chart


Description: A url to the tilemap of the chart for use in TMS chartplotting apps


Description: Region related to note. A pointer to a region UUID. Alternative to geohash


Description: A geohash (see http://geohash.org)


Description: A url to the chart file's storage location


Description: The scale of the chart, the larger number from 1:200000


Description: The format of the chart


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Title: route

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


Description: A route, named with a UUID


Description: Route's common name


Description: A description of the route


Units: m

Description: Total distance from start to end


Description: The waypoint UUID at the start of the route


Description: The waypoint UUID at the end of the route


Title: Feature

Description: A Geo JSON feature object which describes the route between the waypoints


Description: [missing]


Title: LineString

Description: [missing]


Description: [missing]


Description: [missing]


Description: Additional data of any type


Description: [missing]


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Title: notes

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


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


Description: Note's common name


Description: A textual description of the note


Description: Region related to note. A pointer to a region UUID. Alternative to position or geohash


Description: [missing]


Units: deg

Description: Longitude


Units: deg

Description: Latitude


Units: m

Description: Altitude


Description: A geohash (see http://geohash.org)


Description: MIME type of the note


Description: Location of the note


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Title: region

Description: A holder for regions, each named with UUID


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


Description: geohash of the approximate boundary of this region


Title: Feature

Description: A Geo JSON feature object which describes the regions boundary


Description: [missing]


Description: [missing]


Description: Additional data of any type


Description: [missing]


Description: Source of data, a record of where the data was received from. An object containing at least the properties defined in 'properties', but can contain anything beyond that.


Description: A label to identify the source bus, eg serial-COM1, eth-local,etc . Can be anything but should follow a predicatable format


Description: A human name to identify the type. NMEA0183, NMEA2000, signalk


Description: NMEA2000 src value or any similar value for encapsulating the original source of the data


Description: Talker id of the source NMEA0183 sentence, $[GP]RMC,092750.000,A,5321.6802,N,00630.3372,W,0.02,31.66,280511,,,A*43


Title: waypoints

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


Description: A waypoint, an object with a signal k position object, and GeoJSON Feature object (see geojson.org, and https://github.com/fge/sample-json-schemas/tree/master/geojson)


Description: [missing]


Units: deg

Description: Longitude


Units: deg

Description: Latitude


Units: m

Description: Altitude


Title: Feature

Description: A Geo JSON feature object


Description: [missing]


Title: Point

Description: [missing]


Description: [missing]


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


Description: Additional data of any type


Description: [missing]


Description: Version of the Signal K schema/APIs used by the root object.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment