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

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
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
17 changes: 9 additions & 8 deletions gitbook-docs/keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -879,19 +879,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 vessel's 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 vessel's speed through water (STW), negative to port

**Units:**rad

Expand All @@ -903,31 +903,32 @@ The angle the wind needs to shift to raise an alarm


## environment.wind.directionMagnetic
The wind direction relative to magnetic north
Wind direction over water, relative to magnetic north


**Units:**rad


## environment.wind.directionTrue
The wind direction relative to true north
True Wind Direction over water (TWD), relative to true north

**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 speedApparent (AWS) and vessel's speed over ground (SOG)

**Units:**m/s


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

**Units:**m/s

Expand Down
Loading