From fb2c38253febac9db2d3c9a24aacda02a6586194 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frank=20Bo=C3=ABs?= Date: Sun, 24 Mar 2019 09:44:14 +0100 Subject: [PATCH] Improve documentation --- aerofly-wettergeraet.sln | 4 +++ docs/README.md | 10 ++++++++ docs/aerofly-config.md | 51 ++++++++++++++++++++++++++++++++++++++ docs/configuration.md | 2 +- docs/issue_template.md | 23 +++++++++++++++++ docs/metar.md | 53 ++++++++++++++++++++++++++++++++++++++++ 6 files changed, 142 insertions(+), 1 deletion(-) create mode 100644 docs/README.md create mode 100644 docs/aerofly-config.md create mode 100644 docs/issue_template.md create mode 100644 docs/metar.md diff --git a/aerofly-wettergeraet.sln b/aerofly-wettergeraet.sln index 4eb08d2..d422891 100644 --- a/aerofly-wettergeraet.sln +++ b/aerofly-wettergeraet.sln @@ -10,12 +10,16 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution .editorconfig = .editorconfig .gitattributes = .gitattributes .gitignore = .gitignore + docs\aerofly-config.md = docs\aerofly-config.md CHANGELOG.md = CHANGELOG.md docs\configuration.md = docs\configuration.md CONTRIBUTING.md = CONTRIBUTING.md docs\favicon.ico = docs\favicon.ico + docs\issue_template.md = docs\issue_template.md LICENSE.txt = LICENSE.txt + docs\metar.md = docs\metar.md README.md = README.md + docs\README.md = docs\README.md EndProjectSection EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "MetarParserSimple", "src\MetarParserSimple\MetarParserSimple.vcxproj", "{E73E5FBC-5F94-482C-9A5A-B99C9010DA99}" diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..ee4e0c6 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,10 @@ +![](./favicon-64x64.png) Documentation +====================================== + +1. [Advanced configuration](configuration.md) +1. [A small guide to METAR information](metar.md) +1. [How these tools interact with Aerofly'S `main.mcf`](aerofly-config.md) + +--- + +Return to [installation and update guide](../README.md). diff --git a/docs/aerofly-config.md b/docs/aerofly-config.md new file mode 100644 index 0000000..3af4346 --- /dev/null +++ b/docs/aerofly-config.md @@ -0,0 +1,51 @@ +![](./favicon-64x64.png) Settings in Aerofly's `main.mcf` +========================================================= + +This tool modifies the following settings in Aerofly's `main.mcf`: + +``` +<[tm_time_utc][time_utc][] # Time is set in UTC + <[int32][time_year][2016]> # Year as four digit integer, can not be set in simulation + <[int32][time_month][5]> # Month as 1-2 digit integer, can not be set in simulation + <[int32][time_day][20]> # Day of month as 1-2 digit integer, can not be set in simulation + <[float64][time_hours][0]> # UTC time; minutes as fractions of 100/60 +> +<[float64][visibility][0]> # Percent, 0..1 +<[tmsettings_wind][wind][] + <[float64][strength][0]> # Percent, 0..1, but can be set bigger than 1 + <[float64][direction_in_degree][0]> # 0..359 + <[float64][turbulence][0]> # Percent, 0..1 + <[float64][thermal_activity][0]> # Percent, 0..1 +> +<[tmsettings_clouds][clouds][] + <[float64][cumulus_density][0]> # Percent, 0..1 + <[float64][cumulus_height][0]> # Percent, 0..1, but can be set bigger than 1 + <[float64][cumulus_mediocris_density][0]> # see above, can not be set in simulation + <[float64][cumulus_mediocris_height][0]> # see above, can not be set in simulation + <[float64][cirrus_height][0]> # see above + <[float64][cirrus_density][0]> # see above +> +``` + +Visibility +---------- + +Visibility tests set maximum visibility in Aerofly FS 2 to 20,000 meters. + +Wind +---- + +Setting the **wind strength** to `1` yields a wind speed of ~16 knots; setting it to `2` yields ~48 knots, and `4` yields ~160 knots. This implies an exponential function, which can be approximated by `f(x) = 8 * (x + x^2)`, with `x` being the value set and `f(x)` returning the resulting wind speed in knots. + +**Turbulence** causes the wind to change its direction of attack in Aerofly FS2, as well as change its speed. The direct impact has not been measured yet. + +The effect of **thermal activity** has not been measured yet. + +Cloud height +------------ + +Setting the cloud height to `1` yields a cloud height of 40.000 feet AGL. + +--- + +Return to [table of contents](README.md). diff --git a/docs/configuration.md b/docs/configuration.md index 6a16937..b2601df 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -53,4 +53,4 @@ setx AEROFLYWX_FILE %AEROFLYWX_FILE% --- -Return to [table of contents](../README.md). +Return to [table of contents](README.md). diff --git a/docs/issue_template.md b/docs/issue_template.md new file mode 100644 index 0000000..2a647b8 --- /dev/null +++ b/docs/issue_template.md @@ -0,0 +1,23 @@ +What is the problem? +-------------------- + +… + +What did I do before encountering the problem? +---------------------------------------------- + +1. … +2. … + +What does the error message look like? +-------------------------------------- + +``` +… +``` + +Additional information +---------------------- + +* OS version: … +* Application version: … diff --git a/docs/metar.md b/docs/metar.md new file mode 100644 index 0000000..f60cdf9 --- /dev/null +++ b/docs/metar.md @@ -0,0 +1,53 @@ +![](./favicon-64x64.png) More information on METAR +================================================== + +Wikipedia has an [article on METAR information](https://en.wikipedia.org/wiki/METAR) explaining the very basics. + +Sources for METAR information +----------------------------- + +These sites make METAR information publicly available: + +* https://en.allmetsat.com/metar-taf/ +* https://aviationweather.gov/metar +* https://metars.com/ + +Copy METAR strings found on these pages to `aerowx-metar`. + +Some METAR examples +------------------- + +Some clouds over San Francisco (USA): + +``` +KSFO 050756Z 11007KT 10SM SCT035 BKN200 10/06 A2983 RMK AO2 SLP099 T01000061 401720039 +``` + +Rainy in New York (USA) with limited visibility: + +``` +KLGA 050808Z 04007KT 1SM R04/P6000FT -RA BR BKN006 OVC014 06/04 A2967 RMK AO2 P0001 T00560044 +``` + +A foggy night night in Miami (USA): + +``` +KMIA 050753Z 18007KT 5SM BR FEW005 23/23 A2997 RMK AO2 SLP149 T02280228 +``` + +No wind in Geneva (Switzerland): + +``` +LSGG 050820Z VRB01KT 9999 FEW070 BKN110 M03/M04 Q1033 NOSIG +``` + +Use CheckWX API +--------------- + +If your want to use Aerofly Wettergerät with CheckWx you will need to apply for a CheckWX API key. See https://api.checkwx.com/ on how to get an API key. + +After receiving your API key, you will need to enter this key into your desktop batch file or your [local command line tools](command-line.md). + +--- + +Return to [table of contents](README.md).