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

Get rid of state color in SVG templates #336

Merged
merged 4 commits into from
Jan 4, 2025
Merged

Get rid of state color in SVG templates #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05a6871
Get rid of state color
neilenns Jan 4, 2025
be0494b
Update release notes icon
neilenns Jan 4, 2025
2f3a062
Update the documentation, fix stationVolume
neilenns Jan 4, 2025
17b3ef9
Add breaking change to required labels
neilenns Jan 4, 2025
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
3 changes: 3 additions & 0 deletions .github/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ changelog:
labels:
- ignore-for-release-notes
categories:
- title: Breaking changes ⚠️
labels:
- breaking change
- title: New features 🎉
labels:
- feature
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/pr_label_required.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
count: 1
add_comment: true
labels: |
breaking change
ignore-for-release-notes
feature
enhancement
Expand Down
15 changes: 14 additions & 1 deletion com.neil-enns.trackaudio.sdPlugin/images/actions/atisLetter/template.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 20 additions & 1 deletion com.neil-enns.trackaudio.sdPlugin/images/actions/hotline/template.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 12 additions & 1 deletion com.neil-enns.trackaudio.sdPlugin/images/actions/pushToTalk/template.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 0 additions & 13 deletions com.neil-enns.trackaudio.sdPlugin/images/actions/stationStatus/withMute.svg
View file
Open in desktop

This file was deleted.

15 changes: 14 additions & 1 deletion com.neil-enns.trackaudio.sdPlugin/images/actions/trackAudioStatus/template.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
163 changes: 100 additions & 63 deletions docs/svgTemplates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
- [Hotline variables](#hotline-variables)
- [Push to talk variables](#push-to-talk-variables)
- [Station status variables](#station-status-variables)
- [Station volume variables](#station-volume-variables)
- [TrackAudio status variables](#trackaudio-status-variables)
- [Additional Handlebars helpers](#additional-handlebars-helpers)

## Introduction

Expand All @@ -15,7 +17,20 @@ For example, the following SVG template renders an ATIS letter large with the ac

```xml
<svg xmlns="http://www.w3.org/2000/svg" version="1.2" width="144" height="144">
<rect width="144" height="144" fill="{{stateColor}}" />
<style>
.background {
{{#if (eq state "updated")}}
fill: #f60;
{{else if (eq state "current")}}
fill: black;
{{else if (eq state "unavailable")}}
fill: black;
{{else}}
fill: black;
{{/if}}
}
</style>
<rect class="background" width="144" height="144" />
<text x="72" y="36" font-family="Arial" font-weight="bold" font-size="22" text-anchor="middle"
fill="white">{{title}}</text>
<text x="72" y="92" fill="white" font-family="Arial" font-weight="bold" font-size="60" text-anchor="middle">{{#if
Expand All @@ -35,62 +50,53 @@ Results in an action displayed like this:

The following variables are supported with the ATIS letter action:

| Variable | Description |
| ---------- | --------------------------------------------------------------- |
| callsign | The callsign for the ATIS station |
| letter | The current ATIS letter, or undefined if no letter is available |
| state | The name for the action's current state |
| stateColor | The default color for the action's current state |
| title | The title specified by the user |
| Variable | Description |
| -------- | --------------------------------------------------------------- |
| callsign | The callsign for the ATIS station |
| letter | The current ATIS letter, or undefined if no letter is available |
| state | The action's current state |
| title | The title specified by the user |

The state names and colors are:
The states are:

| stateName | stateColor |
| --------- | ---------- |
| current | black |
| updated | #f60 |
- current
- updated

## Hotline variables

The following variables are supported with the hotline action:

| Variable | Description |
| ---------------- | ------------------------------------------------ |
| hotlineCallsign | The hotline callsign |
| hotlineFrequency | The frequency for the hotline callsign |
| primaryCallsign | The primary callsign |
| primaryFrequency | The frequency for the primary callsign |
| state | The name for the action's current state |
| stateColor | The default color for the action's current state |
| title | The title specified by the user |

The state names and colors are:

| stateName | stateColor |
| ------------- | ---------- |
| bothActive | #900 |
| hotlineActive | #c60 |
| listening | #009 |
| neitherActive | black |
| receiving | #060 |
| unavailable | black |
| Variable | Description |
| ---------------- | -------------------------------------- |
| hotlineCallsign | The hotline callsign |
| hotlineFrequency | The frequency for the hotline callsign |
| primaryCallsign | The primary callsign |
| primaryFrequency | The frequency for the primary callsign |
| state | The action's current state |
| title | The title specified by the user |

The states are:

- bothActive
- hotlineActive
- listening
- neitherActive
- receiving
- unavailable

## Push to talk variables

The following variables are supported with the push to talk action:

| Variable | Description |
| ---------- | ------------------------------------------------ |
| state | The name for the action's current state |
| stateColor | The default color for the action's current state |
| title | The title specified by the user |
| Variable | Description |
| -------- | ------------------------------- |
| state | The action's current state |
| title | The title specified by the user |

The state names and colors are:
The states are:

| stateName | stateColor |
| --------------- | ---------- |
| notTransmitting | black |
| transmitting | #f60 |
- notTransmitting
- transmitting

## Station status variables

Expand All @@ -103,33 +109,64 @@ The following variables are supported with the station status action:
| formattedFrequency | The frequency for the station formatted for display, e.g. 121.900 |
| lastReceivedCallsign | The last received callsign |
| listenTo | The value of the listen to setting |
| state | The name for the action's current state |
| stateColor | The default color for the action's current state |
| state | The action's current state |
| title | The title specified by the user |

The state names and colors are:
The states are:

- activeComs
- listening
- notListening
- unavailable

## Station volume variables

| stateName | stateColor |
| ------------ | ---------- |
| activeComms | #f60 |
| listening | #060 |
| notListening | black |
| unavailable | black |
The following variables are supported with the station volume action:

| Variable | Description |
| ------------ | --------------------------------------------------- |
| state | The action's current state |
| outputVolume | The volume level for the station, between 0 and 100 |

The states are:

- muted
- notMuted
- unavailable

## TrackAudio status variables

The following variables are supported with the TrackAudio status action:

| Variable | Description |
| ---------- | ------------------------------------------------ |
| state | The name for the action's current state |
| stateColor | The default color for the action's current state |
| title | The title specified by the user |
| Variable | Description |
| -------- | --------------------------------------- |
| state | The name for the action's current state |
| title | The title specified by the user |

The states are:

The state names and colors are:
- connected
- notConnected
- voiceConnected

## Additional Handlebars helpers

Logical comparison operators are available in addition to the standard helpers. The
following operators are supported:

| Operator | Description |
| -------- | --------------------- |
| eq | Equals |
| ne | Not equals |
| gt | Greater than |
| gte | Greater than or equal |
| lt | Less than |
| lte | Less than or equal |

Example:

```xml
{{#if (eq state "unavailable")}} {{else}} {{/if}}
```

| stateName | stateColor |
| -------------- | ---------- |
| connected | #5fcdfa |
| notConnected | white |
| voiceConnected | #060 |
A complete example is available in the [default station state template](https://github.com/neilenns/streamdeck-trackaudio/blob/main/com.neil-enns.trackaudio.sdPlugin/images/actions/stationStatus/template.svg?short_path=ca0646b).
9 changes: 0 additions & 9 deletions src/controllers/atisLetter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@ import TitleBuilder from "@root/utils/titleBuilder";
import { stringOrUndefined } from "@root/utils/utils";
import { BaseController } from "./baseController";

const StateColor = {
CURRENT: "black",
UNAVAILABLE: "black",
UPDATED: "#f60",
};

const defaultTemplatePath = "images/actions/atisLetter/template.svg";
const defaultUnavailableTemplatePath =
"images/actions/atisLetter/unavailable.svg";
Expand Down Expand Up @@ -248,7 +242,6 @@ export class AtisLetterController extends BaseController {
if (this.isUnavailable) {
this.setImage(this.unavailableImagePath, {
...replacements,
stateColor: StateColor.CURRENT,
state: "current",
});
return;
Expand All @@ -257,15 +250,13 @@ export class AtisLetterController extends BaseController {
if (this.isUpdated) {
this.setImage(this.updatedImagePath, {
...replacements,
stateColor: StateColor.UPDATED,
state: "updated",
});
return;
}

this.setImage(this.currentImagePath, {
...replacements,
stateColor: StateColor.CURRENT,
state: "current",
});
}
Expand Down
Loading