doc: Change descriptions of keys for wind data to include standard identifiers such as AWS #590
Conversation
…entifiers such as AWS The description of the sk-keys for wind data did not refer to the standard identifiers commonly used in watersports (e.g. AWS, AWA, TWD, ...). For an unambiguous interpretation of what the specific keys represent the standard identifiers are added to the description of the keys.
gitbook-docs/keys.md
Outdated
| @@ -901,31 +901,32 @@ The angle the wind needs to shift to raise an alarm | |||
|
|
|||
|
|
|||
| ## environment.wind.directionMagnetic | |||
| The wind direction relative to magnetic north | |||
| Wind direction based on speed through water (STW), relative to magnetic north | |||
There was a problem hiding this comment.
The wind direction relative to magnetic north is absolute - what you would experience being stationary, so definitely not based on STW.
There was a problem hiding this comment.
I intended to point out that "directionMagnetic" is referring to the wind over water and not to wind over ground, hence the reference to STW. But maybe misleading. What do you think of "Wind direction over water, relative to magnetic north"?
gitbook-docs/keys.md
Outdated
|
|
||
| **Units:**rad | ||
|
|
||
|
|
||
| ## environment.wind.directionTrue | ||
| The wind direction relative to true north | ||
| True Wind Direction (TWD) based on speed through water (STW), relative to true north |
gitbook-docs/keys.md
Outdated
|
|
||
| **Units:**m/s | ||
|
|
||
|
|
||
| ## environment.wind.speedOverGround | ||
| Wind speed over ground (as calculated from speedApparent and vessel's speed over ground) | ||
| Ground Wind Speed (GWS), calculated from apparent wind speed (AWS) and speed over ground (SOG) |
There was a problem hiding this comment.
speedApparent in the original is used specifically to refer to the Signal K path, I don't want to drop that. Also I'd like to keep the word vessel.
There was a problem hiding this comment.
Ok, will revert to "speedApparent (AWS)" and "vessel's speed over ground"
schemas/groups/environment.json
Outdated
| @@ -303,27 +303,27 @@ | |||
| "units": "rad" | |||
| }, | |||
| "directionTrue": { | |||
| "description": "The wind direction relative to true north", | |||
| "description": "True Wind Direction (TWD) based on speed through water (STW), relative to true north", | |||
schemas/groups/environment.json
Outdated
| "$ref": "../definitions.json#/definitions/numberValue", | ||
| "units": "rad" | ||
| }, | ||
| "directionMagnetic": { | ||
| "description": "The wind direction relative to magnetic north", | ||
| "description": "Wind direction based on speed through water (STW), relative to magnetic north", |
schemas/groups/environment.json
Outdated
| "$ref": "../definitions.json#/definitions/numberValue", | ||
| "units": "rad" | ||
| }, | ||
| "speedTrue": { | ||
| "description": "Wind speed over water (as calculated from speedApparent and vessel's speed through water)", | ||
| "description": "True Wind Speed (TWS) over water, calculated from apparent wind speed (AWS) and speed through water (STW)", |
There was a problem hiding this comment.
Ok, will revert to "speedApparent (AWS)" and "vessel's speed trough water"
schemas/groups/environment.json
Outdated
| "$ref": "../definitions.json#/definitions/numberValue", | ||
| "units": "m/s" | ||
| }, | ||
| "speedOverGround": { | ||
| "description": "Wind speed over ground (as calculated from speedApparent and vessel's speed over ground)", | ||
| "description": "Ground Wind Speed (GWS), calculated from apparent wind speed (AWS) and speed over ground (SOG)", |
There was a problem hiding this comment.
Ok, will revert to "speedApparent (AWS)" and "vessel's speed over ground"
Updated PR following the review suggestions by Teppo
The description of the sk-keys for wind data did not refer to the standard identifiers commonly used in watersports (e.g. AWS, AWA, TWD, ...). For an unambiguous interpretation of what the specific keys represent the standard identifiers are added to the description of the keys.