diff --git a/README.md b/README.md index 5088b04..4eb929c 100644 --- a/README.md +++ b/README.md @@ -8,72 +8,6 @@ This Stream Deck plugin provides actions to interact with [vATIS](https://vatis.app/) running on your local machine. [Download the plugin from the releases page](https://github.com/neilenns/streamdeck-vatis/releases/latest). -Do you use TrackAudio when controlling? Check out the companion [Stream Deck actions for TrackAudio](https://marketplace.elgato.com/product/trackaudio-e913a0ca-4c12-411d-a5a6-acf5f6c4bdea). - -## Action descriptions - -| Action | Description | -| ------------ | -------------------------------------------------------------------- | -| ATIS letter | Shows the current ATIS letter and altimeter for a specific station. | -| vATIS status | Shows the current state of the connection to vATIS from Stream Deck. | - -After installation the plugin actions are available under the vATIS category: - -![Screenshot of the Stream Deck profile UI with the vATIS category open](docs/images/streamdeck-category.png) - -## Configuring an ATIS letter action - -The ATIS letter action displays the station name, current AITS letter, and current altimeter -for a single station in vATIS. - -Pressing the action clears the new ATIS indicator in vATIS and on the action. A long press of the action clears the new ATIS indicator on all stations in vATIS. - -By default the pressure displays in white. For pressure reported in inches of mercury, -if the value falls below 29.92 the value will show in red as a reminder that FL180 (or FL190, -depending on the altimeter value) are be unusable. - -For example, if you have published a combined ATIS at KLMT in vATIS you can configure an action -like this to display the information on your Stream Deck: - -![Screnshot of an ATIS letter action configuration, with the title and callsign set to KPDX and the type set to Combined.](docs/images/atis-letter.png) +[Read the documentation](https://projects.neilenns.com/docs/streamdeck-vatis) for information on how to set up actions and examples of common configurations. -### ATIS letter settings - -| Setting | Description | Default | -| ----------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| Title | The title to show on the action. Optional. | Blank | -| Station | The name of the station you want to display status for. Required. | | -| Type | The type of the station. | Combined | -| Current | The image to display when the ATIS letter shown is current. Optional. | ![Black background, white text](docs/images/atis-connected.png) ![Black background, white text, red text for pressure](docs/images/atis-warning.png) | -| Unavailable | The image to display when there is no connection to vATIS. Optional. | ![Black background, "ATIS" for letter, grey text](docs/images/atis-notconnected.png) | -| Updated | The image to display when the ATIS letter updated to a new one. Optional. | ![Orange background, white text](docs/images/atis-updated.png) | - -The default display automatically includes the station name, ATIS letter, and altimeter. When specifying -custom images the following advanced settings can be used to display text on the action: - -| Setting | Description | Default | -| -------------- | ---------------------------------- | ------- | -| Show altimeter | Shows the altimeter on the action. | false | -| Show letter | Shows the letter on the action. | false | -| Show title | Shows the title on the action. | false | -| Show wind | Shows the wind on the action. | false | - -## Configuring a vATIS status action - -The vATIS status action shows the status of the connection between Stream Deck and vATIS. -A long press of the action will force a refresh of all the Stream Deck vATIS actions. - -## vATIS status action settings - -| Setting | Description | Default | -| ------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| Title | The title to show on the action. Optional. | Blank | -| Connected | The image to display when connected to vATIS. Optional. | ![Orange sun with grey cloud, black background](docs/images/vatis-connected.png) | -| Not connected | The image to display when not connected to vATIS. Optional. | ![Cloud and sun outlined in grey, black background](docs/images/vatis-notconnected.png) | -| Show title | Shows the title on the action. | false | - -## SVG templates - -All image properties support SVG templates using [Handlebars](https://handlebarsjs.com/). This enables using a single SVG image across multiple -actions that respond to state changes. For more information on the available template variables see the -[documentation on the wiki](https://github.com/neilenns/streamdeck-vatis/wiki/SVG-templates). +Do you use TrackAudio when controlling? Check out the companion [Stream Deck actions for TrackAudio](https://marketplace.elgato.com/product/trackaudio-e913a0ca-4c12-411d-a5a6-acf5f6c4bdea). diff --git a/com.neil-enns.vatis.sdPlugin/manifest.json b/com.neil-enns.vatis.sdPlugin/manifest.json index 2416482..8f83af5 100644 --- a/com.neil-enns.vatis.sdPlugin/manifest.json +++ b/com.neil-enns.vatis.sdPlugin/manifest.json @@ -42,7 +42,7 @@ "Description": "Provides actions for displaying current ATIS information from vATIS.", "Icon": "images/plugin/pluginIcon", "SDKVersion": 2, - "URL": "https://github.com/neilenns/streamdeck-vatis", + "URL": "https://projects.neilenns.com/docs/streamdeck-vatis/", "Software": { "MinimumVersion": "6.4" }, diff --git a/docs/images/atis-connected.png b/docs/images/atis-connected.png deleted file mode 100644 index 815115a..0000000 Binary files a/docs/images/atis-connected.png and /dev/null differ diff --git a/docs/images/atis-letter.png b/docs/images/atis-letter.png deleted file mode 100644 index 90b08dc..0000000 Binary files a/docs/images/atis-letter.png and /dev/null differ diff --git a/docs/images/atis-notconnected.png b/docs/images/atis-notconnected.png deleted file mode 100644 index 1db1941..0000000 Binary files a/docs/images/atis-notconnected.png and /dev/null differ diff --git a/docs/images/atis-updated.png b/docs/images/atis-updated.png deleted file mode 100644 index f2ab2ce..0000000 Binary files a/docs/images/atis-updated.png and /dev/null differ diff --git a/docs/images/atis-warning.png b/docs/images/atis-warning.png deleted file mode 100644 index 3d2cfe9..0000000 Binary files a/docs/images/atis-warning.png and /dev/null differ diff --git a/docs/images/streamdeck-category.png b/docs/images/streamdeck-category.png deleted file mode 100644 index 71b9ef7..0000000 Binary files a/docs/images/streamdeck-category.png and /dev/null differ diff --git a/docs/images/vatis-connected.png b/docs/images/vatis-connected.png deleted file mode 100644 index ec8f229..0000000 Binary files a/docs/images/vatis-connected.png and /dev/null differ diff --git a/docs/images/vatis-notconnected.png b/docs/images/vatis-notconnected.png deleted file mode 100644 index a320685..0000000 Binary files a/docs/images/vatis-notconnected.png and /dev/null differ