This commit is contained in:
core 2023-11-09 10:43:47 -05:00
parent 00baabe3ff
commit 95618c5b5c
Signed by: core
GPG Key ID: FDBF740DADDCEECF
3 changed files with 60 additions and 2 deletions

View File

@ -29,10 +29,54 @@ RTWX is a realtime browser application and therefore requires an internet connec
## Opening RTWX
*Reserved*
To open RTWX, open [rtwx.e3t.cc](https://rtwx.e3t.cc) in your browser. After a brief flash, your page should display the main scope window.
## The Scope
After you initially load RTWX, the scope will appear blank. This is because text is hidden by default. To show it, enter the command `` `T `` to toggle `` ` `` text `T`.
The scope is broken down into 5 main parts.
### Status Information Area
In the top left of the scope is the *Status Information Area.*
![Status Information Area](status_information_area.png)
It will consist of multiple lines, telling you:
- the scope you are in (almost always `NEXRAD`)
- the current radar site ICAO (in this case `INOP`, as the radar is inoperative)
- any currently active alerts (in this case, there is an alert that the radar is inoperative because there is no data loaded)
#### Common Alerts
There are a few alerts that are very common:
| Alert | Meaning | Reason | To Fix |
|------------------------------------|------------------------------------------------------------------------------|---------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| `RADAR INOPERATIVE NO DATA LOADED` | The radar is currently not working because no radar data has been loaded. | A file has not yet been loaded or a dataserver track has not yet been started. | Load a file locally (with `CLF OV`) or start a dataserver track (see [Dataserver](#data-server)) |
| `NEW DATA AVAIL RLD RQD` | There is new data in the buffer that needs to be reloaded into the scope | A new file has been uploaded or a dataserver track has received new radar data. | Reload the scope (with `CLF RELOAD`) |
| `DATASERVER TRACK LOST` | A track on the dataserver has been lost (is no longer responding to queries) | The client has been disconnected from the dataserver for unknown reasons. | Typically caused by a transient network error. Try reloading the browser. If issue persists, check your internet connection. |
### Command Buffer
On the left middle of the scope, below the Status Information Area, is the *Command Buffer*:
![Command Buffer](command_buffer.png)
The command buffer will contain any commands you are entering and responses to those commands. It may span multiple lines depending on the command.
### Site Information Area
*Reserved*
### Mode Selector
*Reserved*
### Radar Scope
*Reserved*
## Local Operations
@ -45,4 +89,18 @@ RTWX is a realtime browser application and therefore requires an internet connec
## Command Reference
*Reserved*
### Toggle Commands (prefix: `)
| Command | Description |
|----------|------------------|
| `` `T `` | Toggle Text |
| `` `R `` | Toggle Radar |
| `` `L `` | Toggle Lightning |
| `` `A `` | Toggle Alerts |
### Currently Loaded File (prefix: `CLF`)
| Command | Description |
|--------------|-----------------------------------------------------------------------|
| `CLF OV` | Overwrite the currently loaded file with one from your local machine. |
| `CLF RELOAD` | Reload the displayed data from the file buffer. |

BIN
docs/command_buffer.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB