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.

Sign up for GitHub

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

doc: Change descriptions of keys for wind data to include standard identifiers such as AWS #590

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

doc: Change descriptions of keys for wind data to include standard identifiers such as AWS #590

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c98f2d
doc: Change descriptions of keys for wind data to include standard id…
chris0348 Oct 7, 2020
c3b54ca
chore: update dependencies
tkurki Mar 23, 2021
b0c7f9d
Merge remote-tracking branch 'upstream/master' into my-fix-branch
chris0348 Mar 28, 2021
fa47046
doc: Change descriptions of keys for wind data - updated PR
chris0348 Mar 28, 2021
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
17 changes: 9 additions & 8 deletions gitbook-docs/keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,19 +877,19 @@ Current water temperature


## environment.wind.angleApparent
Apparent wind angle, negative to port
Apparent Wind Angle (AWA), negative to port

**Units:**rad


## environment.wind.angleTrueGround
True wind angle based on speed over ground, negative to port
Ground Wind Angle (GWA) based on speed over ground (SOG), negative to port

**Units:**rad


## environment.wind.angleTrueWater
True wind angle based on speed through water, negative to port
True Wind Angle (TWA) based on speed through water (STW), negative to port

**Units:**rad

Expand All @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wind direction relative to magnetic north is absolute - what you would experience being stationary, so definitely not based on STW.

Copy link
Author

@chris0348 chris0348 Nov 1, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"?



**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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again not based on STW.


**Units:**rad


## environment.wind.speedApparent
Apparent wind speed
Apparent Wind Speed (AWS)

**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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, will revert to "speedApparent (AWS)" and "vessel's speed over ground"


**Units:**m/s


## environment.wind.speedTrue
Wind speed over water (as calculated from speedApparent and vessel's speed through water)
True Wind Speed (TWS) over water, calculated from apparent wind speed (AWS) and speed through water (STW)

**Units:**m/s

Expand Down
18 changes: 9 additions & 9 deletions schemas/groups/environment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,17 +283,17 @@
"description": "Wind data.",
"properties": {
"angleApparent": {
"description": "Apparent wind angle, negative to port",
"description": "Apparent Wind Angle (AWA), negative to port",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
},
"angleTrueGround": {
"description": "True wind angle based on speed over ground, negative to port",
"description": "Ground Wind Angle (GWA) based on speed over ground (SOG), negative to port",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
},
"angleTrueWater": {
"description": "True wind angle based on speed through water, negative to port",
"description": "True Wind Angle (TWA) based on speed through water (STW), negative to port",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "rad"
},
Expand All @@ -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",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sic

"$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",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sic

"$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)",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sic

Copy link
Author

@chris0348 chris0348 Nov 1, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, will revert to "speedApparent (AWS)" and "vessel's speed trough water"

"$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)",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sic

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, will revert to "speedApparent (AWS)" and "vessel's speed over ground"

"$ref": "../definitions.json#/definitions/numberValue",
"units": "m/s"
},
"speedApparent": {
"description": "Apparent wind speed",
"description": "Apparent Wind Speed (AWS)",
"$ref": "../definitions.json#/definitions/numberValue",
"units": "m/s"
}
Expand Down Expand Up @@ -388,4 +388,4 @@
}
}
}
}
}