Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Meteo schema #662

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 131 additions & 0 deletions schemas/groups/environment.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"feelsLikeTemperature": {
"description": "Current outside feels like temperature",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "K"
},
"apparentWindChillTemperature": {
"description": "Current outside apparent wind chill temperature",
"$ref": "../definitions.json#/definitions/numberValue",
Expand All @@ -86,6 +91,15 @@
"$ref": "../definitions.json#/definitions/numberValue",
"units": "Pa"
},
"pressureTendency": {
"description": "Integer value indicating barometric pressure value tendency e.g. 0 = steady, etc.",
"$ref": "../definitions.json#/definitions/numberValue"
},
"pressureTendencyType": {
"description": "Description for the value of pressureTendency e.g. steady, increasing, decreasing.",
"type": "string",
"enum": ["steady", "increasing", "decreasing"]
},
"humidity": {
"description": "DEPRECATED: use relativeHumidity",
"$ref": "../definitions.json#/definitions/numberValue",
Expand All @@ -96,6 +110,11 @@
"$ref": "../definitions.json#/definitions/numberValue",
"units": "ratio"
},
"absoluteHumidity": {
"description": "Current outside air absolute humidity",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "ratio"
},
"airDensity": {
"description": "Current outside air density",
"units": "kg/m3",
Expand All @@ -105,9 +124,50 @@
"description": "Current outside ambient light flux.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "Lux"
},
"uvIndex" : {
"description": "Level of UV radiation. 1 UVI = 25mW/sqm.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "UVI"
},
"cloudCover" : {
"description": "Level of cloud clover.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "ratio"
},
"horizontalVisibility" : {
"description": "Visibility distance at ground level.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"horizontalVisibilityOverRange" : {
"description": "True if visibilty distance is greater than the range of the measuring equipment.",
"type": "boolean"
}



}
},
"date" : {
"description": "Date and time of the observation.",
"$ref": "../definitions.json#/definitions/datetimeValue"
},
"sun": {
"type": "object",
"description": "Times of sun related events.",
"properties": {
"sunrise" : {
"description": "Time at which sun rises at location.",
"$ref": "../definitions.json#/definitions/datetimeValue"
},
"sunset" : {
"description": "Time at which sun sets at location.",
"$ref": "../definitions.json#/definitions/datetimeValue"
}
}

},
"inside": {
"type": "object",
"description": "Environmental conditions inside the vessel's hull",
Expand Down Expand Up @@ -138,6 +198,62 @@
"description": "Water salinity",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "ratio"
},
"level": {
"description": "Water level.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"levelTendency": {
"description": "Integer value indicating water level tendency e.g. 0 = steady, etc",
"$ref": "../definitions.json#/definitions/numberValue"
},
"levelTendencyType": {
"description": "Description for the value of levelTendency e.g. steady, increasing, decreasing.",
"type": "string",
"enum": ["steady", "increasing", "decreasing"]
},
"waves": {
"type": "object",
"description": "Wave conditions of the water that the vessel is sailing in",
"properties": {
"significantHeight": {
"description": "Estimated height of significant waves.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"period": {
"description": "Estimated wave period.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "ms"
},
"directon": {
"description": "Estimated wave direction.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
}
}
},
"swell": {
"type": "object",
"description": "Swell conditions of the water that the vessel is sailing in",
"properties": {
"significantHeight": {
"description": "Estimated height of swell.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m"
},
"period": {
"description": "Estimated swell period.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "ms"
},
"directon": {
"description": "Estimated swell direction.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
}
}
}
}
},
Expand Down Expand Up @@ -336,6 +452,21 @@
"description": "Apparent wind speed",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m/s"
},
"averageSpeed": {
"description": "Average wind speed.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m/s"
},
"gust": {
"description": "Maximum wind gust.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m/s"
},
"gustDirectionTrue": {
"description": "Maximum wind gust direction relative to true north.",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
}
}
},
Expand Down
52 changes: 52 additions & 0 deletions schemas/meteo.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://signalk.org/specification/1.5.1/schemas/meteo.json#",
"description": "An object describing a weather station. It should be an object in meteo, named using MMSI or a UUID",
"title": "Weather Stations",
"anyOf": [
{
"required": [
"mmsi"
]
},
{
"required": [
"url"
]
},
{
"required": [
"uuid"
]
}
],
"properties": {
"url": {
"description": "URL based identity of the weather station, if available.",
"$ref": "definitions.json#/definitions/url"
},
"mmsi": {
"description": "MMSI number of the weather station, if available.",
"$ref": "definitions.json#/definitions/sarMmsi"
},
"uuid": {
"description": "A unique Signal K flavoured maritime resource identifier, assigned by the server.",
"$ref": "definitions.json#/definitions/uuid",
"example": "urn:mrn:signalk:uuid:b7590868-1d62-47d9-989c-32321b349fb9"
},
"name": {
"type": "string",
"description": "The common name of the weather station.",
"example": "Motu"
},
"navigation": {
"description": "Navigation data including Position, Course to next WP information, etc.",
"$ref": "groups/navigation.json#"
},
"environment": {
"description": "Environment data.",
"$ref": "groups/environment.json#"
}
}
}
Loading