/**"
13 | ],
14 | "program": "${workspaceFolder}/app.js",
15 | "env": {
16 | "USE_ADMIN": "true",
17 | "DEBUG": "true",
18 | "ADMIN_MODE": "true",
19 | "PLUGINS_PATH": "${workspaceFolder}/_plugins",
20 | "ENABLE_IMAGE_GENERATION": "true",
21 | "PORT": "3000",
22 | "USE_CACHE": "false"
23 | },
24 | "console": "integratedTerminal",
25 | "internalConsoleOptions": "neverOpen"
26 | }
27 | ]
28 | }
--------------------------------------------------------------------------------
/_plugins/NTFY/views/half_horizontal.liquid:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | {% assign max_rows = trmnl.plugin_settings.custom_fields_values.max_rows | default: 5 %}
5 | {% assign reversed_data = data | reverse %}
6 | {% assign flex = true %}
7 |
8 | {% for alert in reversed_data limit: max_rows %}
9 |
10 |
11 |
12 | {{ alert.time | date: "%-d%b %I:%M %p" }}
13 | {{ alert.message }}
14 |
15 |
16 |
17 | {% endfor %}
18 |
19 |
20 |
22 |
24 |
Topic: {{ trmnl.plugin_settings.custom_fields_values.topic_name }}
25 |
3 |
4 |
5 | Header 1 Header 2 Header 3
9 |
10 |
11 |
12 | Row 1, Cell 1 Row 1, Cell 2 Row 1, Cell 3
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 | Header 1 Header 2 Header 3
27 |
28 |
29 |
30 | Row 1, Cell 1 Row 1, Cell 2 Row 1, Cell 3
34 |
35 |
--------------------------------------------------------------------------------
/_plugins/epl-fixtures/settings.yml:
--------------------------------------------------------------------------------
1 | ---
2 | strategy: polling
3 | no_screen_padding: 'yes'
4 | dark_mode: 'no'
5 | static_data: ''
6 | polling_verb: get
7 | polling_url: https://raw.githubusercontent.com/openfootball/football.json/refs/heads/master/2024-25/en.1.json
8 | polling_headers: 'content-type: application/json'
9 | custom_fields:
10 | - keyname: myteam
11 | field_type: select
12 | options:
13 | - None
14 | - AFC Bournemouth
15 | - Arsenal FC
16 | - Aston Villa FC
17 | - Brentford FC
18 | - Brighton & Hove Albion FC
19 | - Chelsea FC
20 | - Crystal Palace FC
21 | - Everton FC
22 | - Fulham FC
23 | - Ipswich Town FC
24 | - Leicester City FC
25 | - Liverpool FC
26 | - Manchester City FC
27 | - Manchester United FC
28 | - Newcastle United FC
29 | - Nottingham Forest FC
30 | - Southampton FC
31 | - Tottenham Hotspur FC
32 | - West Ham United FC
33 | - Wolverhampton Wanderers FC
34 | default: None
35 | name: My Team
36 | description: Choose a team to highlight
37 | name: EPL Fixtures
38 | description: Shows English Premier League fixtures and results from the open football.json dataset. Displays match dates, teams, and scores for the current season.
39 | refresh_interval: 43200
40 |
41 | custom_fields_values:
42 | myteam: "brighton_&_hove_albion_fc"
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0)
2 |
3 | Copyright (c) 2025 Stu Eggerton
4 |
5 | This work is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.
6 |
7 | To view a copy of this license, visit:
8 | http://creativecommons.org/licenses/by-nc/4.0/
9 |
10 | You are free to:
11 | * Share — copy and redistribute the material in any medium or format
12 | * Adapt — remix, transform, and build upon the material
13 |
14 | Under the following terms:
15 | * Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made.
16 | * NonCommercial — You may not use the material for commercial purposes.
17 |
18 | No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
19 |
20 | Notices:
21 | You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
22 |
23 | No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
--------------------------------------------------------------------------------
/_plugins/epl-my-team/settings.yml:
--------------------------------------------------------------------------------
1 | ---
2 | strategy: polling
3 | no_screen_padding: 'no'
4 | dark_mode: 'no'
5 | static_data: ''
6 | polling_verb: get
7 | polling_url: https://raw.githubusercontent.com/openfootball/football.json/refs/heads/master/2024-25/en.1.json
8 | polling_headers: 'content-type: application/json'
9 | name: EPL My Team
10 | description: Displays Manchester United's fixtures and results from the open football.json dataset. Shows past results and upcoming matches for the current season.
11 | refresh_interval: 43200
12 |
13 | custom_fields:
14 | - keyname: myteam
15 | field_type: select
16 | options:
17 | - None
18 | - AFC Bournemouth
19 | - Arsenal FC
20 | - Aston Villa FC
21 | - Brentford FC
22 | - Brighton & Hove Albion FC
23 | - Chelsea FC
24 | - Crystal Palace FC
25 | - Everton FC
26 | - Fulham FC
27 | - Ipswich Town FC
28 | - Leicester City FC
29 | - Liverpool FC
30 | - Manchester City FC
31 | - Manchester United FC
32 | - Newcastle United FC
33 | - Nottingham Forest FC
34 | - Southampton FC
35 | - Tottenham Hotspur FC
36 | - West Ham United FC
37 | - Wolverhampton Wanderers FC
38 | default: None
39 | name: My Team
40 | description: Choose a team to highlight
41 |
42 | custom_fields_values:
43 | myteam: "brighton_&_hove_albion_fc"
--------------------------------------------------------------------------------
/_plugins/NTFY/views/full.liquid:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | {% assign max_rows = trmnl.plugin_settings.custom_fields_values.max_rows | default: 5 %}
5 | {% assign reversed_data = data | reverse %}
6 | {% assign flex = true %}
7 |
8 | {% if alerts.size > 0 %}
9 | {% for alert in reversed_data limit: max_rows %}
10 |
11 |
12 |
13 | {{ alert.time | date: "%-d%b %I:%M %p" }}
14 | {{ alert.message }}
15 |
16 |
17 |
18 | {% endfor %}
19 | {% else %}
20 |
21 | NO alerts found
22 | Check your topic and try again
23 |
24 |
25 | {% endif %}
26 |
27 |
28 |
31 |
33 |
Topic: {{ data[0].topic | truncate: 8}}
34 |
9 |
10 |
11 |
12 |
13 | Time Speed Gusts
17 |
18 |
19 | {% for i in (start_time_hour..end_time_hour) %}
20 | {% assign time = hourly.time[i] | date: "%H:%M" %}
21 |
22 | {{ time }} {{ hourly.wind_speed_10m[i] }} {{ hourly.wind_gusts_10m[i] }}
26 | {% endfor %}
27 |
28 |
29 |
30 |
33 |
Wind Speed
34 |
Open-Meteo
35 |
9 |
10 |
Wind Conditions for {{ lat }}, {{ long }}
11 |
Timezone: {{ tz }}
12 |
13 |
14 |
15 |
16 |
17 |
18 | Time
19 | Speed
20 | Dir
21 | Gusts
22 |
23 |
24 |
25 | {% for i in (start_time_hour..end_time_hour) %}
26 | {% assign time = hourly.time[i] | date: "%H:%M" %}
27 |
28 | {{ time }}
29 | {{ hourly.wind_speed_10m[i] }}
30 | {{ hourly.wind_direction_10m[i] }}°
31 | {{ hourly.wind_gusts_10m[i] }}
32 |
33 | {% endfor %}
34 |
35 |
36 |
37 |
40 |
Wind Speed & Direction
41 |
Data from Open-Meteo
42 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 | {% for entity in entities %}
14 | {% if entity.device_class != "temperature" %}
15 |
16 | {{ entity.friendly_name }} {{ entity.value }}{{ entity.attributes.unit_of_measurement }} {{ entity.state }}{{ entity.unit_of_measurement }}
23 | {% endif %}
24 | {% endfor %}
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 | Home Assistant
35 | Other Sensors
36 |
37 |
8 |
9 |
10 | {% if text.size < 20 %}
11 | {{ text }}
12 | {% elsif text.size < 40 %}
13 | {{ text }}
14 | {% elsif text.size < 70 %}
15 | {{ text }}
16 | {% elsif text.size < 120 %}
17 | {{ text }}
18 | {% elsif text.size < 200 %}
19 | {{ text }}
20 | {% else %}
21 | {{ text }}
22 | {% endif %}
23 |
24 |
25 |
26 |
28 | {% if trmnl.device.percent_charged > 60 %}
29 |
--------------------------------------------------------------------------------
/_plugins/trmnl-broadcast/views/quadrant.liquid:
--------------------------------------------------------------------------------
1 |
6 |
7 |
8 |
9 |
10 | {% if text.size < 5 %}
11 | {{ text }}
12 | {% elsif text.size < 10 %}
13 | {{ text }}
14 | {% elsif text.size < 15 %}
15 | {{ text }}
16 | {% elsif text.size < 20 %}
17 | {{ text }}
18 | {% elsif text.size < 25 %}
19 | {{ text }}
20 | {% else %}
21 | {{ text }}
22 | {% endif %}
23 |
24 |
25 |
26 |
28 | {% if trmnl.device.percent_charged > 60 %}
29 |
--------------------------------------------------------------------------------
/_plugins/trmnl-broadcast/views/half_vertical.liquid:
--------------------------------------------------------------------------------
1 |
6 |
7 |
8 |
9 |
10 | {% if text.size < 15 %}
11 | {{ text }}
12 | {% elsif text.size < 30 %}
13 | {{ text }}
14 | {% elsif text.size < 55 %}
15 | {{ text }}
16 | {% elsif text.size < 90 %}
17 | {{ text }}
18 | {% elsif text.size < 120 %}
19 | {{ text }}
20 | {% else %}
21 | {{ text }}
22 | {% endif %}
23 |
24 |
25 |
26 |
28 | {% if trmnl.device.percent_charged > 60 %}
29 |
--------------------------------------------------------------------------------
/_plugins/trmnl-broadcast/views/half_horizontal.liquid:
--------------------------------------------------------------------------------
1 |
6 |
7 |
8 |
9 |
10 | {% if text.size < 15 %}
11 | {{ text }}
12 | {% elsif text.size < 30 %}
13 | {{ text }}
14 | {% elsif text.size < 55 %}
15 | {{ text }}
16 | {% elsif text.size < 90 %}
17 | {{ text }}
18 | {% elsif text.size < 120 %}
19 | {{ text }}
20 | {% else %}
21 | {{ text }}
22 | {% endif %}
23 |
24 |
25 |
26 |
28 | {% if trmnl.device.percent_charged > 60 %}
29 |
--------------------------------------------------------------------------------
/scripts/docker-run.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | # Check if port 3000 is in use and capture the details
4 | port_info=$(netstat -an | grep LISTEN | grep 3000)
5 |
6 | if [[ -n "$port_info" ]]; then
7 | echo "Error: Port 3000 is already in use. Details:"
8 | echo "$port_info"
9 | exit 1
10 | fi
11 |
12 | # Determine the host architecture
13 | ARCH=$(uname -m)
14 | case $ARCH in
15 | arm64|aarch64)
16 | PLATFORM="linux/arm64"
17 | ;;
18 | x86_64|amd64)
19 | PLATFORM="linux/amd64"
20 | ;;
21 | *)
22 | echo "Unsupported architecture: $ARCH"
23 | exit 1
24 | ;;
25 | esac
26 |
27 | # Build the image using the shell script
28 | echo "Building for platform: $PLATFORM"
29 |
30 | # Build the image for the detected platform
31 | # Check if no-cache parameter was passed
32 | if [[ "$1" == "no-cache" ]]; then
33 | echo "Building with no-cache"
34 | docker build --platform $PLATFORM \
35 | --no-cache \
36 | -t trmnl-plugin-tester:latest \
37 | --build-arg BUILDPLATFORM=$PLATFORM .
38 | else
39 | echo "Building with cache (add no-cache if you want to force a rebuild)"
40 | docker build --platform $PLATFORM \
41 | -t trmnl-plugin-tester:latest \
42 | --build-arg BUILDPLATFORM=$PLATFORM .
43 | fi
44 |
45 | # Run the container with the correct platform
46 | echo "Running container for platform: $PLATFORM"
47 |
48 | docker run --platform $PLATFORM \
49 | -p 3000:3000 \
50 | -v "$(pwd)/_plugins:/app/_plugins" \
51 | -v "$(pwd)/cache:/data/cache" \
52 | -e DEBUG_MODE=true \
53 | -e ENABLE_IMAGE_GENERATION=true \
54 | trmnl-plugin-tester:latest
--------------------------------------------------------------------------------
/_plugins/wind-speed-direction/views/full.liquid:
--------------------------------------------------------------------------------
1 | {% assign lat = latitude | default: "UNKNOWN" %}
2 | {% assign long = longitude | default: "UNKNOWN" %}
3 | {% assign tz = trmnl.user.time_zone_iana | default: "UNKNOWN" %}
4 |
5 | {% assign start_time_hour = 8 %}
6 | {% assign end_time_hour = 19 %}
7 |
8 | {% assign current_time = "now" | date: "%Y-%m-%d %H:00" %}
9 | {% assign end_time = "now" | date: "%Y-%m-%d" | append: " 23:00" %}
10 |
11 |
12 |
13 |
Wind Conditions for
14 |
{{ lat }}, {{ long }}
15 |
Timezone: {{ tz }}
16 |
17 |
18 |
19 |
20 |
21 |
22 | Time
23 | Wind Speed ({{ hourly_units.wind_speed_10m }})
24 | Direction ({{ hourly_units.wind_direction_10m }})
25 | Gusts ({{ hourly_units.wind_gusts_10m }})
26 |
27 |
28 |
29 | {% for i in (start_time_hour..end_time_hour) %}
30 | {% assign time = hourly.time[i] | date: "%H:%M" %}
31 |
32 | {{ time }}
33 | {{ hourly.wind_speed_10m[i] }}
34 | {{ hourly.wind_direction_10m[i] }}°
35 | {{ hourly.wind_gusts_10m[i] }}
36 |
37 | {% endfor %}
38 |
39 |
40 |
41 |
44 |
Wind Speed & Direction
45 |
Data from Open-Meteo for {{ trmnl.user.first_name }}
46 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | {% for entity in entities %}
18 | {% if entity.device_class == "temperature" %}
19 |
20 | {{ entity.friendly_name }}
27 | {% endif %}
28 | {% endfor %}
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 | Home Assistant
39 | Temperature Sensors
40 |
41 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | {% for entity in entities %}
18 | {% if entity.device_class == "temperature" %}
19 |
20 | {{ entity.friendly_name }}
27 | {% endif %}
28 | {% endfor %}
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 | Home Assistant
39 | Temperature
40 |
41 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
Motivational Quote
26 |
“I love inside jokes. I hope to be a part of one
27 | someday.”
28 |
Michael Scott
29 |
30 |
31 |
32 |
33 |
34 |
35 |
Plugin Title
36 |
Instance Title
37 |
38 |
39 |
40 |
41 |
TRMNL Display Preview
5 |
47 |
48 |
49 |
50 |
TRMNL Display Preview
51 |
52 | Refresh Preview
53 |
54 |
55 |
18 |
20 |
21 |
22 | ### Key Features
23 |
24 | - **Periodic Notifications**: The plugin polls for the latest alerts and displays them as they arrive. Because the TRMNL device is an e-ink display, it will only update periodically conserving battery life.
25 |
26 | **REAL TIME NOTIFICATIONS ARE NOT SUPPORTED ON THE TRMNL DEVICE.**
27 |
28 | ## How to use the NTFY plugin
29 |
30 | There are many integrations for ntfy.sh, and you can use any of them to send messages to the topic.
31 |
32 | ### Web
33 |
34 | You can send messages to the topic using the ntfy.sh [web interface](https://ntfy.sh/trmnl-example12345/publish?title=Hello%20World&message=This%20is%20a%20test%20message)
35 |
36 | ### NTFY CLI
37 | You can send messages to the topic using the `ntfy` command line tool.
38 |
39 | ```bash
40 | ntfy publish --topic trmnl-example12345 --title "Hello World" --message "This is a test message"
41 | ```
42 |
43 | ### Curl
44 | ```bash
45 | curl -X POST https://ntfy.sh/trmnl-example12345/publish?title=Hello%20World&message=This%20is%20a%20test%20message
46 | ```
47 |
48 | ### Home Assistant
49 | You can [send messages to the topic from Home Assistant](https://docs.ntfy.sh/examples/#home-assistant) in the configuration.yaml file.
50 |
51 |
52 | ### Others
53 | There are many other integrations for ntfy.sh, and you can use any of them to send messages to the topic.
54 |
55 | See the [ntfy.sh examples](https://docs.ntfy.sh/examples/) for more information.
56 |
57 |
58 |
59 |
60 | This plugin provides a simple and effective way to monitor and display ntfy alerts, making it easier for you to stay updated with real-time notifications.
61 |
62 | Happy notifying!
63 |
--------------------------------------------------------------------------------
/_plugins/epl-fixtures/views/half_vertical.liquid:
--------------------------------------------------------------------------------
1 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 | Date Fixture
53 |
54 |
55 | {% assign today = "now" | date: "%Y-%m-%d" %}
56 | {% assign counter = 0 %}
57 | {% assign upcoming_matches = matches | sort: "date" %}
58 | {% for match in upcoming_matches %}
59 | {% if match.date > today and counter < 15 %}
60 | {% assign match_date = match.date | date: "%d %b" %}
61 | {% assign home_abbr = match.team1 | slice: 0, 9 %}
62 | {% assign away_abbr = match.team2 | slice: 0, 9 %}
63 | {% assign score = match.score.ft[0] | append: " - " | append: match.score.ft[1] %}
64 |
65 | {{ match_date }}
67 | {{ home_abbr }}
68 | {{ score }}
69 | {{ away_abbr }}
70 |
71 |
72 | {% assign counter = counter | plus: 1 %}
73 | {% endif %}
74 | {% endfor %}
75 |
76 |
77 |
78 |
79 |
45 |
46 |
47 |
48 |
49 |
50 | Date Fixture
53 |
54 |
55 | {% assign today = "now" | date: "%Y-%m-%d" %}
56 | {% assign counter = 0 %}
57 | {% assign upcoming_matches = matches | sort: "date" %}
58 | {% for match in upcoming_matches %}
59 | {% if match.date > today and counter < 5 %}
60 | {% assign match_date = match.date | date: "%d %b" %}
61 | {% assign home_abbr = match.team1 | slice: 0, 9 %}
62 | {% assign away_abbr = match.team2 | slice: 0, 9 %}
63 | {% assign score = match.score.ft[0] | append: " - " | append: match.score.ft[1] %}
64 |
65 | {{ match_date }}
67 | {{ home_abbr }}
68 | {{ score }}
69 | {{ away_abbr }}
70 |
71 |
72 | {% assign counter = counter | plus: 1 %}
73 | {% endif %}
74 | {% endfor %}
75 |
76 |
77 |
78 |
79 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 | Date Time Home Away
31 |
32 |
33 | {% assign today = "now" | date: "%Y-%m-%d" %}
34 | {% assign counter = 0 %}
35 | {% assign upcoming_matches = matches | sort: "date" %}
36 |
37 | {% assign myteam = trmnl.plugin_settings.custom_fields_values.myteam %}
38 |
39 | {% for match in upcoming_matches %}
40 | {% if match.date > today and counter < 9 %} {% assign formatted_date=match.date | date: "%-d %b" %}
42 |
43 | {{ formatted_date }} {{ match.time }}
46 |
47 | {% assign normalized_team1 = match.team1 | downcase | replace: " ", "_" %}
48 | {% if myteam == normalized_team1 %}
49 | {{ match.team1 }}
50 | {% else %}
51 | {{ match.team1 }}
52 | {% endif %}
53 |
54 |
55 |
56 |
57 | {% assign normalized_team2 = match.team2 | downcase | replace: " ", "_" %}
58 | {% if myteam == normalized_team2 %}
59 | {{ match.team2 }}
60 | {% else %}
61 | {{ match.team2 }}
62 | {% endif %}
63 |
64 |
65 |
66 |
67 | {% if match.score.ft %}
68 | {{ match.score.ft[0] }} - {{ match.score.ft[1] }}
69 | {% endif %}
70 |
71 |
72 |
73 | {% assign counter = counter | plus: 1 %}
74 | {% endif %}
75 | {% endfor %}
76 |
77 |
78 |
79 |
81 |
82 |
Premier League
83 |
Upcoming Fixtures
84 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 | Location Value
17 |
18 |
19 | {% for entity in entities %}
20 | {% if entity.device_class == "temperature" %}
21 |
22 | {{ entity.friendly_name }}
33 | {% endif %}
34 | {% endfor %}
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | Sensor Value
49 |
50 |
51 | {% for entity in entities %}
52 | {% if entity.device_class != "temperature" %}
53 |
54 | {{ entity.friendly_name }} {{ entity.value }}{{ entity.attributes.unit_of_measurement }} {{ entity.state }}{{ entity.unit_of_measurement }}
62 | {% endif %}
63 | {% endfor %}
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 | Home Assistant
74 | Entities labelled TRMNL
75 |
76 |
55 |
56 |
57 |
58 |
59 | {% assign current_time = 'now' | date: '%H%M' %}
60 | {% assign random_index = "now" | date: "%s" | modulo: snippets.size %}
61 | {% assign snippet = snippets[random_index] %}
62 |
63 | {% for line in snippet.lines %}
64 | {% if line contains '{**TRMNL**}' %}
65 | {% assign parts = line | split: '{**TRMNL**}' %}
66 |
{{ parts[0] }}{{ current_time }} {{ parts[1] }}
67 | {% else %}
68 |
{{ line }}
69 | {% endif %}
70 | {% unless forloop.last %}
{% endunless %}
71 | {% endfor %}
72 |
73 |
74 |
75 |
76 |
77 |
80 | Code Clock
81 | The above time is < now()
82 |
--------------------------------------------------------------------------------
/_plugins/code-clock/views/half_horizontal.liquid:
--------------------------------------------------------------------------------
1 |
52 |
53 |
54 |
55 |
56 |
57 |
58 | {% assign current_time = 'now' | date: '%H%M' %}
59 | {% assign random_index = "now" | date: "%s" | modulo: snippets.size %}
60 | {% assign snippet = snippets[random_index] %}
61 |
62 | {% for line in snippet.lines %}
63 | {% if line contains '{**TRMNL**}' %}
64 | {% assign parts = line | split: '{**TRMNL**}' %}
65 |
{{ parts[0] }}{{ current_time }} {{ parts[1] }}
66 | {% else %}
67 |
{{ line }}
68 | {% endif %}
69 | {% unless forloop.last %}
{% endunless %}
70 | {% endfor %}
71 |
72 |
73 |
74 |
75 |
76 |
79 | Code Clock
80 | The above time is < now()
81 |
--------------------------------------------------------------------------------
/_plugins/code-clock/views/quadrant.liquid:
--------------------------------------------------------------------------------
1 |
53 |
54 |
55 |
56 |
57 |
58 |
59 | {% assign current_time = 'now' | date: '%H%M' %}
60 | {% assign random_index = "now" | date: "%s" | modulo: snippets.size %}
61 | {% assign snippet = snippets[random_index] %}
62 |
63 | {% for line in snippet.lines %}
64 | {% if line contains '{**TRMNL**}' %}
65 | {% assign parts = line | split: '{**TRMNL**}' %}
66 |
{{ parts[0] }}{{ current_time }} {{ parts[1] }}
67 | {% else %}
68 |
{{ line }}
69 | {% endif %}
70 | {% unless forloop.last %}
{% endunless %}
71 | {% endfor %}
72 |
73 |
74 |
75 |
76 |
77 |
80 | Code Clock
81 | The above time is < now()
82 |
--------------------------------------------------------------------------------
/_plugins/epl-fixtures/views/half_horizontal.liquid:
--------------------------------------------------------------------------------
1 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 | Match # Date Time Home Away Score
41 |
42 |
43 | {% assign today = "now" | date: "%Y-%m-%d" %}
44 | {% assign counter = 0 %}
45 | {% assign upcoming_matches = matches | sort: "date" %}
46 | {% for match in upcoming_matches %}
47 | {% if match.date > today and counter < 15 %}
48 | {% assign formatted_date = match.date | date: "%-d %b" %}
49 |
50 | {{ forloop.index0 | plus: 1 }} {{ formatted_date }} {{ match.time }}
54 |
55 | {% if match.score.ft[0] > match.score.ft[1] %}
56 | {{ match.team1 }}
57 | {% else %}
58 | {{ match.team1 }}
59 | {% endif %}
60 |
61 |
62 |
63 |
64 | {% if match.score.ft[1] > match.score.ft[0] %}
65 | {{ match.team2 }}
66 | {% else %}
67 | {{ match.team2 }}
68 | {% endif %}
69 |
70 |
71 |
72 |
73 | {% if match.score.ft %}
74 | {{ match.score.ft[0] }} - {{ match.score.ft[1] }}
75 | {% else %}
76 | TBD
77 | {% endif %}
78 |
79 |
80 |
81 | {% assign counter = counter | plus: 1 %}
82 | {% endif %}
83 | {% endfor %}
84 |
85 |
86 |
87 |
88 |
66 |
67 |
68 |
69 |
70 | {% assign current_time = 'now' | date: '%H%M' %}
71 | {% assign random_index = "now" | date: "%s" | modulo: snippets.size %}
72 | {% assign snippet = snippets[random_index] %}
73 |
74 | {% for line in snippet.lines %}
75 | {% if line contains '{**TRMNL**}' %}
76 | {% assign parts = line | split: '{**TRMNL**}' %}
77 |
{{ parts[0] }}{{ current_time }} {{ parts[1] }}
78 | {% else %}
79 |
{{ line }}
80 | {% endif %}
81 | {% unless forloop.last %}
{% endunless %}
82 | {% endfor %}
83 |
84 |
85 |
86 |
87 |
88 |
91 | Code Clock
92 | The above time is < now()
93 |
94 |
--------------------------------------------------------------------------------
/admin/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Device Management Admin
6 |
7 |
8 |
9 |
Device Management
10 |
16 |
17 |
18 |
19 |
20 | MAC
21 | API Key
22 | Description
23 | Actions
24 |
25 |
26 |
28 |
30 |
Admin UI Title Bar
31 |
2 |
3 | {% assign items_per_column = 5 %}
4 | {% assign items_before_wrap = items_per_column | minus: 1 %}
5 | {% assign max_cols = 2 %}
6 |
7 |
8 | {% assign item_count = 0 %}
9 | {% assign current_col = 1 %}
10 | {% for day in agenda %}
11 | {% if item_count == items_before_wrap %}
12 |
13 | {% assign item_count = items_per_column %}
14 | {% endif %}
15 |
16 | {% if item_count == items_per_column %}
17 | {% if current_col < max_cols %}
18 |
19 | {% assign current_col = current_col | plus: 1 %}
20 | {% assign item_count = 0 %}
21 | {% else %}
22 | {% break %}
23 | {% endif %}
24 | {% endif %}
25 |
26 | {% if item_count < items_before_wrap %}
27 |
28 |
29 | {{ day.date | date: "%A" }}, {{ day.date | date: "%-d%b" }}
30 |
31 | {% assign item_count = item_count | plus: 1 %}
32 |
33 | {% for event in day.events %}
34 | {% if item_count == items_per_column %}
35 |
36 | {% if current_col < max_cols %}
37 |
38 | {% assign current_col = current_col | plus: 1 %}
39 | {% assign item_count = 0 %}
40 |
41 | {% else %}
42 | {% break %}
43 | {% endif %}
44 | {% endif %}
45 |
46 | {% if item_count < items_per_column %}
47 |
48 |
49 | {{ forloop.index }}
50 |
51 |
52 |
53 | {{ event.title }}
54 | {% if event.crossDay %}
55 | →
56 | {% endif %}
57 |
58 |
59 | {% if event.isFullDay %}
60 | All Day
61 | {% else %}
62 | {{ event.start | date: "%I:%M %p" | timezone: timezone }} - {{ event.end | date: "%I:%M %p" | timezone: timezone }}
63 | {% endif %}
64 |
65 |
66 |
67 | {% assign item_count = item_count | plus: 1 %}
68 | {% endif %}
69 | {% endfor %}
70 |
71 | {% endif %}
72 | {% endfor %}
73 |
74 | {% if item_count > 0 and item_count < items_per_column %}
75 | {% assign remaining = items_per_column | minus: item_count %}
76 | {% for i in (1..remaining) %}
77 |
78 | {% endfor %}
79 | {% endif %}
80 |
81 |
82 |
85 | My Agenda
86 |
--------------------------------------------------------------------------------
/_plugins/my-agenda/views/half_horizontal.liquid:
--------------------------------------------------------------------------------
1 |
2 |
3 | {% assign items_per_column = 5 %}
4 | {% assign items_before_wrap = items_per_column | minus: 1 %}
5 | {% assign max_cols = 2 %}
6 |
7 |
8 | {% assign item_count = 0 %}
9 | {% assign current_col = 1 %}
10 | {% for day in agenda %}
11 | {% if item_count == items_before_wrap %}
12 |
13 | {% assign item_count = items_per_column %}
14 | {% endif %}
15 |
16 | {% if item_count == items_per_column %}
17 | {% if current_col < max_cols %}
18 |
19 | {% assign current_col = current_col | plus: 1 %}
20 | {% assign item_count = 0 %}
21 | {% else %}
22 | {% break %}
23 | {% endif %}
24 | {% endif %}
25 |
26 | {% if item_count < items_before_wrap %}
27 |
28 |
29 | {{ day.date | date: "%A" }}, {{ day.date | date: "%-d%b" }}
30 |
31 | {% assign item_count = item_count | plus: 1 %}
32 |
33 | {% for event in day.events %}
34 | {% if item_count == items_per_column %}
35 |
36 | {% if current_col < max_cols %}
37 |
38 | {% assign current_col = current_col | plus: 1 %}
39 | {% assign item_count = 0 %}
40 |
41 | {% else %}
42 | {% break %}
43 | {% endif %}
44 | {% endif %}
45 |
46 | {% if item_count < items_per_column %}
47 |
48 |
49 | {{ forloop.index }}
50 |
51 |
52 |
53 | {{ event.title }}
54 | {% if event.crossDay %}
55 | →
56 | {% endif %}
57 |
58 |
59 | {% if event.isFullDay %}
60 | All Day
61 | {% else %}
62 | {{ event.start | date: "%I:%M %p" | timezone: timezone }} - {{ event.end | date: "%I:%M %p" | timezone: timezone }}
63 | {% endif %}
64 |
65 |
66 |
67 | {% assign item_count = item_count | plus: 1 %}
68 | {% endif %}
69 | {% endfor %}
70 |
71 | {% endif %}
72 | {% endfor %}
73 |
74 | {% if item_count > 0 and item_count < items_per_column %}
75 | {% assign remaining = items_per_column | minus: item_count %}
76 | {% for i in (1..remaining) %}
77 |
78 | {% endfor %}
79 | {% endif %}
80 |
81 |
82 |
85 | My Agenda
86 |
--------------------------------------------------------------------------------
/_plugins/my-agenda/views/half_vertical.liquid:
--------------------------------------------------------------------------------
1 |
2 |
3 | {% assign items_per_column = 10 %}
4 | {% assign items_before_wrap = items_per_column | minus: 1 %}
5 | {% assign max_cols = 2 %}
6 |
7 |
8 | {% assign item_count = 0 %}
9 | {% assign current_col = 1 %}
10 | {% for day in agenda %}
11 | {% if item_count == items_before_wrap %}
12 |
13 | {% assign item_count = items_per_column %}
14 | {% endif %}
15 |
16 | {% if item_count == items_per_column %}
17 | {% if current_col < max_cols %}
18 |
19 | {% assign current_col = current_col | plus: 1 %}
20 | {% assign item_count = 0 %}
21 | {% else %}
22 | {% break %}
23 | {% endif %}
24 | {% endif %}
25 |
26 | {% if item_count < items_before_wrap %}
27 |
28 |
29 | {{ day.date | date: "%A" }}, {{ day.date | date: "%-d%b" }}
30 |
31 | {% assign item_count = item_count | plus: 1 %}
32 |
33 | {% for event in day.events %}
34 | {% if item_count == items_per_column %}
35 |
36 | {% if current_col < max_cols %}
37 |
38 | {% assign current_col = current_col | plus: 1 %}
39 | {% assign item_count = 0 %}
40 |
41 | {% else %}
42 | {% break %}
43 | {% endif %}
44 | {% endif %}
45 |
46 | {% if item_count < items_per_column %}
47 |
48 |
49 | {{ forloop.index }}
50 |
51 |
52 |
53 | {{ event.title }}
54 | {% if event.crossDay %}
55 | →
56 | {% endif %}
57 |
58 |
59 | {% if event.isFullDay %}
60 | All Day
61 | {% else %}
62 | {{ event.start | date: "%I:%M %p" | timezone: timezone }} - {{ event.end | date: "%I:%M %p" | timezone: timezone }}
63 | {% endif %}
64 |
65 |
66 |
67 | {% assign item_count = item_count | plus: 1 %}
68 | {% endif %}
69 | {% endfor %}
70 |
71 | {% endif %}
72 | {% endfor %}
73 |
74 | {% if item_count > 0 and item_count < items_per_column %}
75 | {% assign remaining = items_per_column | minus: item_count %}
76 | {% for i in (1..remaining) %}
77 |
78 | {% endfor %}
79 | {% endif %}
80 |
81 |
82 |
85 | My Agenda
86 |
--------------------------------------------------------------------------------
/_plugins/epl-my-team/views/half_vertical.liquid:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | Home Score Away
14 |
15 |
16 | {% assign counter = 0 %}
17 | {% assign all_matches = matches | sort: "date" | reverse %}
18 |
19 | {% for match in all_matches %}
20 | {% if counter < 7 and match.score.ft and match.score.ft[0] != null %}
21 | {% if match.team1 == "Manchester United FC" or match.team2 == "Manchester United FC" %}
22 | {% assign match_date = match.date | date: "%-d %b" %}
23 |
24 |
25 |
26 | {% if match.score.ft[0] > match.score.ft[1] %}
27 | {{ match.team1 }}
28 | {% else %}
29 | {{ match.team1 }}
30 | {% endif %}
31 |
32 |
33 | {{ match.score.ft[0] }}-{{ match.score.ft[1] }}
35 |
36 | {% if match.score.ft[1] > match.score.ft[0] %}
37 | {{ match.team2 }}
38 | {% else %}
39 | {{ match.team2 }}
40 | {% endif %}
41 |
42 |
43 |
44 | {% assign counter = counter | plus: 1 %}
45 | {% endif %}
46 | {% endif %}
47 | {% endfor %}
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 | {% assign counter = 0 %}
58 | {% assign upcoming_matches = matches | sort: "date" %}
59 | {% for match in upcoming_matches %}{% if counter < 7 and match.score.ft == nil %}{% if match.team1 == "Manchester United FC" or match.team2 == "Manchester United FC" %}{% assign match_date = match.date | date: "%-d %b" %}{% if match.team1 == "Manchester United FC" %}{{ match_date }} HOME {{ match.team2 }}{% else %}{{ match_date }} AWAY {{ match.team1 }}{% endif %}{% unless forloop.last %}, {% endunless %}{% assign counter = counter | plus: 1 %}{% endif %}{% endif %}{% endfor %}
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
Manchester United FC
68 |
Results & Fixtures
69 |
70 |
2 |
3 |
4 |
5 |
6 |
7 |
Recent Results
8 |
9 |
10 |
11 | Date Home Score Away
16 |
17 |
18 | {% assign counter = 0 %}
19 | {% assign all_matches = matches | sort: "date" | reverse %}
20 | {% assign myteam = trmnl.plugin_settings.custom_fields_values.myteam %}
21 |
22 | {% for match in all_matches %}
23 | {% if counter < 7 and match.score.ft and match.score.ft[0] != nil %}
24 |
25 | {% assign normalized_team1 = match.team1 | downcase | replace: " ", "_" %}
26 | {% assign normalized_team2 = match.team2 | downcase | replace: " ", "_" %}
27 |
28 | {% if normalized_team1 == myteam or normalized_team2 == myteam %}
29 | {% assign match_date = match.date | date: "%-d %b" %}
30 |
31 | {{ match_date }}
33 |
34 | {% if match.score.ft[0] > match.score.ft[1] %}
35 | {{ match.team1 }}
36 | {% else %}
37 | {{ match.team1 }}
38 | {% endif %}
39 |
40 |
41 | {{ match.score.ft[0] }} - {{ match.score.ft[1] }}
43 |
44 | {% if match.score.ft[1] > match.score.ft[0] %}
45 | {{ match.team2 }}
46 | {% else %}
47 | {{ match.team2 }}
48 | {% endif %}
49 |
50 |
51 |
52 | {% assign counter = counter | plus: 1 %}
53 | {% endif %}
54 | {% endif %}
55 | {% endfor %}
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
Upcoming Fixtures
65 |
66 |
67 |
68 | Date Time Home Away
73 |
74 |
75 | {% assign counter = 0 %}
76 | {% assign upcoming_matches = matches | sort: "date" %}
77 |
78 | {% for match in upcoming_matches %}
79 | {% if counter < 7 and match.score.ft == nil %}
80 |
81 | {% assign normalized_team1 = match.team1 | downcase | replace: " ", "_" %}
82 | {% assign normalized_team2 = match.team2 | downcase | replace: " ", "_" %}
83 |
84 | {% if normalized_team1 == myteam or normalized_team2 == myteam %}
85 | {% assign match_date = match.date | date: "%-d %b" %}
86 |
87 | {{ match_date }} {{ match.time }} {{ match.team1 }} {{ match.team2 }}
92 | {% assign counter = counter | plus: 1 %}
93 | {% endif %}
94 | {% endif %}
95 | {% endfor %}
96 |
97 |
98 |
99 |
100 |
101 |
102 |
103 |
104 |
{{ myteam | replace: "_", " " | upcase }}
105 |
Results & Fixtures
106 |
107 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | Date Home Score Away
15 |
16 |
17 | {% assign counter = 0 %}
18 | {% assign all_matches = matches | sort: "date" | reverse %}
19 |
20 | {% for match in all_matches %}
21 | {% if counter < 1 and match.score.ft and match.score.ft[0] != null %} {% if
22 | match.team1=="Manchester United FC" or match.team2=="Manchester United FC" %} {% assign
23 | match_date=match.date | date: "%-d %b" %}
24 | {{ match_date }}
26 |
27 | {% if match.score.ft[0] > match.score.ft[1] %}
28 | {{ match.team1 }}
29 | {% else %}
30 | {{ match.team1 }}
31 | {% endif %}
32 |
33 |
34 | {{ match.score.ft[0] }}-{{ match.score.ft[1]
35 | }}
37 |
38 | {% if match.score.ft[1] > match.score.ft[0] %}
39 | {{ match.team2 }}
40 | {% else %}
41 | {{ match.team2 }}
42 | {% endif %}
43 |
44 |
45 |
46 | {% assign counter = counter | plus: 1 %}
47 | {% endif %}
48 | {% endif %}
49 | {% endfor %}
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 | Date Time Home Away
66 |
67 |
68 | {% assign counter = 0 %}
69 | {% assign upcoming_matches = matches | sort: "date" %}
70 |
71 | {% for match in upcoming_matches %}
72 | {% if counter < 1 and match.score.ft==nil %} {% if match.team1=="Manchester United FC" or
73 | match.team2=="Manchester United FC" %} {% assign match_date=match.date | date: "%-d %b"
74 | %}
75 | {{ match_date }} {{ match.time }} {{ match.team1 }} {{ match.team2 }}
80 | {% assign counter = counter | plus: 1 %}
81 | {% endif %}
82 | {% endif %}
83 | {% endfor %}
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
Manchester United FC
93 |
Results & Fixtures
94 |
95 |
2 |
3 |
4 |
5 |
6 |
7 |
Recent Results
8 |
9 |
10 |
11 | Date Home Score Away
16 |
17 |
18 | {% assign counter = 0 %}
19 | {% assign all_matches = matches | sort: "date" | reverse %}
20 |
21 | {% for match in all_matches %}
22 | {% if counter < 3 and match.score.ft and match.score.ft[0] != nil %} {% if
23 | match.team1=="Manchester United FC" or match.team2=="Manchester United FC" %} {% assign
24 | match_date=match.date | date: "%-d %b" %}
25 | {{ match_date }}
27 |
28 | {% if match.score.ft[0] > match.score.ft[1] %}
29 | {{ match.team1 }}
30 | {% else %}
31 | {{ match.team1 }}
32 | {% endif %}
33 |
34 |
35 | {{ match.score.ft[0] }} - {{ match.score.ft[1]
36 | }}
38 |
39 | {% if match.score.ft[1] > match.score.ft[0] %}
40 | {{ match.team2 }}
41 | {% else %}
42 | {{ match.team2 }}
43 | {% endif %}
44 |
45 |
46 |
47 | {% assign counter = counter | plus: 1 %}
48 | {% endif %}
49 | {% endif %}
50 | {% endfor %}
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
Upcoming Fixtures
60 |
61 |
62 |
63 | Date Time Home Away
68 |
69 |
70 | {% assign counter = 0 %}
71 | {% assign upcoming_matches = matches | sort: "date" %}
72 |
73 | {% for match in upcoming_matches %}
74 | {% if counter < 3 and match.score.ft==nil %} {% if match.team1=="Manchester United FC" or
75 | match.team2=="Manchester United FC" %} {% assign match_date=match.date | date: "%-d %b"
76 | %}
77 | {{ match_date }} {{ match.time }} {{ match.team1 }} {{ match.team2 }}
82 | {% assign counter = counter | plus: 1 %}
83 | {% endif %}
84 | {% endif %}
85 | {% endfor %}
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
Manchester United FC
95 |
Results & Fixtures
96 |
97 |
8 |
9 |
10 |
11 | {% assign item_count = 0 %}
12 | {% assign current_col = 1 %}
13 | {% for day in agenda %}
14 | {% if item_count == items_before_wrap %}
15 |
{% comment %}Add dummy item to fill column{% endcomment %}
16 | {% assign item_count = items_per_column %}
17 | {% endif %}
18 |
19 | {% if item_count == items_per_column %}
20 | {% if current_col < max_cols %}
21 |
22 | {% assign current_col = current_col | plus: 1 %}
23 | {% assign item_count = 0 %}
24 | {% else %}
25 | {% break %}
26 | {% endif %}
27 | {% endif %}
28 |
29 | {% comment %}Only start a new day if we have room for header + at least 1 event{% endcomment %}
30 | {% if item_count < items_before_wrap %}
31 |
32 |
33 | {{ day.date | date: "%A" }}, {{ day.date | date: "%-d%b" }}
34 |
35 | {% assign item_count = item_count | plus: 1 %}
36 |
37 | {% for event in day.events %}
38 | {% if item_count == items_per_column %}
39 |
40 | {% if current_col < max_cols %}
41 |
42 | {% assign current_col = current_col | plus: 1 %}
43 | {% assign item_count = 0 %}
44 |
45 | {% else %}
46 | {% break %}
47 | {% endif %}
48 | {% endif %}
49 |
50 | {% if item_count < items_per_column %}
51 |
52 |
53 | {{ forloop.index }}
54 |
55 |
56 |
57 | {{ event.title }}
58 | {% if event.crossDay %}
59 | →
60 | {% endif %}
61 |
62 |
63 | {% if event.isFullDay %}
64 | All Day
65 | {% else %}
66 | {{ event.start | date: "%I:%M %p" | timezone: timezone }} - {{ event.end | date: "%I:%M %p" | timezone: timezone }}
67 | {% endif %}
68 |
69 |
70 |
71 | {% assign item_count = item_count | plus: 1 %}
72 | {% endif %}
73 | {% endfor %}
74 |
75 | {% endif %}
76 | {% endfor %}
77 |
78 | {% comment %}Fill remaining slots in last column{% endcomment %}
79 | {% if item_count > 0 and item_count < items_per_column %}
80 | {% assign remaining = items_per_column | minus: item_count %}
81 | {% for i in (1..remaining) %}
82 |
83 | {% endfor %}
84 | {% endif %}
85 |
86 |
87 |
116 | My Agenda
117 |
--------------------------------------------------------------------------------
/download-assets.js:
--------------------------------------------------------------------------------
1 | const fs = require('fs');
2 | const path = require('path');
3 | const https = require('https');
4 | const { promisify } = require('util');
5 | const mkdir = promisify(fs.mkdir);
6 | const writeFile = promisify(fs.writeFile);
7 | const readFile = promisify(fs.readFile);
8 | const stat = promisify(fs.stat);
9 |
10 | const CDN_BASE = 'https://usetrmnl.com';
11 | const CACHE_PATH = process.env.CACHE_PATH || path.join(process.cwd(), 'cache');
12 | const CACHE_FILE = path.join(CACHE_PATH, 'cdn-assets.cache');
13 | const CACHE_DURATION = 10 * 60 * 1000; // 10 minutes in milliseconds
14 | const SOURCE_PATH = path.join(__dirname, 'design-system'); // Path to source files
15 |
16 | // Create cache directory if it doesn't exist
17 | if (!fs.existsSync(CACHE_PATH)) {
18 | fs.mkdirSync(CACHE_PATH, { recursive: true });
19 | }
20 |
21 | // assets to download {localname: remotename}
22 | const assets = {
23 | css: {
24 | 'css/latest/plugins.css': '/css/latest/plugins.css' // Store in same structure as CDN
25 | },
26 | js: {
27 | 'js/latest/plugins.js': '/js/latest/plugins.js' // Store in same structure as CDN
28 | },
29 | fonts: {
30 | 'fonts/NicoClean-Regular.ttf': '/fonts/NicoClean-Regular.ttf',
31 | 'fonts/NicoBold-Regular.ttf': '/fonts/NicoBold-Regular.ttf',
32 | 'fonts/BlockKie.ttf': '/fonts/BlockKie.ttf',
33 | 'fonts/NicoPups-Regular.ttf': '/fonts/NicoPups-Regular.ttf',
34 | 'fonts/inter.css': 'https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap'
35 | },
36 | images: {
37 | // Border images
38 | 'images/borders/1.png': '/images/borders/1.png',
39 | 'images/borders/2.png': '/images/borders/2.png',
40 | 'images/borders/3.png': '/images/borders/3.png',
41 | 'images/borders/4.png': '/images/borders/4.png',
42 | 'images/borders/5.png': '/images/borders/5.png',
43 | 'images/borders/6.png': '/images/borders/6.png',
44 | 'images/borders/7.png': '/images/borders/7.png',
45 | // Grayscale images
46 | 'images/grayscale/gray-1.png': '/images/grayscale/gray-1.png',
47 | 'images/grayscale/gray-2.png': '/images/grayscale/gray-2.png',
48 | 'images/grayscale/gray-3.png': '/images/grayscale/gray-3.png',
49 | 'images/grayscale/gray-4.png': '/images/grayscale/gray-4.png',
50 | 'images/grayscale/gray-5.png': '/images/grayscale/gray-5.png',
51 | 'images/grayscale/gray-6.png': '/images/grayscale/gray-6.png',
52 | 'images/grayscale/gray-7.png': '/images/grayscale/gray-7.png',
53 | 'images/grayscale/gray-out.png': '/images/grayscale/gray-out.png',
54 | // Layout images
55 | 'images/layout/full--title_bar-v2.png': '/images/layout/full--title_bar-v2.png',
56 | 'images/layout/full--title_bar.png': '/images/layout/full--title_bar.png',
57 | 'images/layout/half_horizontal--title_bar.png': '/images/layout/half_horizontal--title_bar.png',
58 | 'images/layout/half_horizontal.png': '/images/layout/half_horizontal.png',
59 | 'images/layout/half_vertical--title_bar.png': '/images/layout/half_vertical--title_bar.png',
60 | 'images/layout/half_vertical.png': '/images/layout/half_vertical.png',
61 | 'images/layout/quadrant--title_bar.png': '/images/layout/quadrant--title_bar.png',
62 | 'images/layout/quadrant.png': '/images/layout/quadrant.png'
63 | }
64 | };
65 |
66 | async function isCacheValid() {
67 | try {
68 | const cacheContent = await readFile(CACHE_FILE, 'utf8');
69 | const cacheTime = parseInt(cacheContent);
70 | const age = Date.now() - cacheTime;
71 | return age <= CACHE_DURATION;
72 | } catch (error) {
73 | return false;
74 | }
75 | }
76 |
77 | async function updateCacheTimestamp() {
78 | await mkdir(path.dirname(CACHE_FILE), { recursive: true });
79 | await writeFile(CACHE_FILE, Date.now().toString());
80 | }
81 |
82 | async function downloadFile(url, outputPath) {
83 | console.log(`Downloading ${url}...`);
84 | return new Promise((resolve, reject) => {
85 | const protocol = url.startsWith('https') ? https : require('http');
86 | protocol.get(url, (response) => {
87 | if (response.statusCode !== 200) {
88 | reject(new Error(`Failed to download ${url}: ${response.statusCode}`));
89 | return;
90 | }
91 |
92 | const chunks = [];
93 | response.on('data', (chunk) => chunks.push(chunk));
94 | response.on('end', async () => {
95 | const buffer = Buffer.concat(chunks);
96 | await mkdir(path.dirname(outputPath), { recursive: true });
97 | await writeFile(outputPath, buffer);
98 | console.log(`Downloaded ${url} to ${outputPath}`);
99 | resolve();
100 | });
101 | }).on('error', reject);
102 | });
103 | }
104 |
105 | async function extractAndDownloadImages(cssPath) {
106 | try {
107 | const cssContent = await readFile(cssPath, 'utf8');
108 | const urlRegex = /url\(['"]?([^'")\s]+)['"]?\)/g;
109 | let match;
110 |
111 | while ((match = urlRegex.exec(cssContent)) !== null) {
112 | const url = match[1];
113 | // Skip data URLs, fonts, and already downloaded files
114 | if (url.startsWith('data:') ||
115 | url.includes('.ttf') ||
116 | url.includes('.woff')) {
117 | continue;
118 | }
119 |
120 | // Convert relative URLs to absolute
121 | const fullUrl = url.startsWith('http') ? url : `${CDN_BASE}${url}`;
122 |
123 | // Create relative path for the image
124 | const relativePath = url.startsWith('http')
125 | ? new URL(url).pathname
126 | : url;
127 | const outputPath = path.join(CACHE_PATH, relativePath.replace(/^\//, ''));
128 |
129 | await downloadFile(fullUrl, outputPath);
130 | }
131 | } catch (error) {
132 | console.error('Error processing images from CSS:', error);
133 | throw error;
134 | }
135 | }
136 |
137 | async function copyDirectory(src, dest) {
138 | try {
139 | await mkdir(dest, { recursive: true });
140 | const entries = await fs.readdir(src, { withFileTypes: true });
141 |
142 | for (const entry of entries) {
143 | const srcPath = path.join(src, entry.name);
144 | const destPath = path.join(dest, entry.name);
145 |
146 | if (entry.isDirectory()) {
147 | await copyDirectory(srcPath, destPath);
148 | } else {
149 | await fs.copyFile(srcPath, destPath);
150 | console.log(`Copied ${srcPath} to ${destPath}`);
151 | }
152 | }
153 | } catch (error) {
154 | console.warn(`Warning: Could not copy directory ${src}, error:`, error.message);
155 | }
156 | }
157 |
158 | async function downloadAssets() {
159 | try {
160 | // If USE_CACHE is false, skip downloading and just use CDN directly
161 | if (process.env.USE_CACHE !== 'true') {
162 | console.log('💾 Cache disabled, using CDN directly:', CDN_BASE);
163 | return;
164 | }
165 |
166 | console.log('💾 Cache enabled, using directory:', CACHE_PATH);
167 |
168 | // Check cache first
169 | if (await isCacheValid()) {
170 | console.log('💾 Using cached CDN files since less than 10 minutes have passed');
171 | return;
172 | }
173 |
174 | console.log('💾 Cache expired or not found, downloading assets...');
175 |
176 | // Download all assets maintaining CDN structure
177 | for (const [type, files] of Object.entries(assets)) {
178 | for (const [outputFile, urlPath] of Object.entries(files)) {
179 | const url = urlPath.startsWith('http') ? urlPath : `${CDN_BASE}${urlPath}`;
180 | const outputPath = path.join(CACHE_PATH, outputFile);
181 | await downloadFile(url, outputPath);
182 | }
183 | }
184 |
185 | // Update cache timestamp
186 | await updateCacheTimestamp();
187 | console.log('💾 All assets downloaded successfully to cache');
188 | } catch (error) {
189 | console.error('💾 Error handling assets:', error);
190 | process.exit(1);
191 | }
192 | }
193 |
194 | module.exports = downloadAssets;
195 |
196 | // Run directly if called from command line
197 | if (require.main === module) {
198 | downloadAssets();
199 | }
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # TRMNL Plugin Tester
2 |
3 | A development tool for testing TRMNL plugins. This project allows you to preview and test plugins locally or in a Docker container before deploying them to the [useTRMNL.com](https://usetrmnl.com) platform.
4 |
5 | ## Features
6 |
7 | - **Plugin Preview**: Preview plugins in various layouts (full, half-horizontal, half-vertical, quadrant).
8 | - Uses standard `settings.yml` format compatible with TRMNL import/export
9 | - Preview plugin content with live data or sample data
10 | - Copy layout templates for different screen sizes
11 | - Export plugins as ZIP files ready for TRMNL import
12 |
13 | - **Local & API Support**: Work with local `sample.json` files or call external APIs for live data.
14 | - **Clipboard Integration**: Copy layouts and API URLs directly to the clipboard for easy pasting into the TRMNL plugin dashboard.
15 | - **Image Generation**: Generate BMP images for TRMNL displays using Puppeteer and ImageMagick.
16 | - **Rate Limiting**: Built-in rate limiting to prevent abuse (default: 400 requests per 5 minutes).
17 | - Basic BYOS features such as
18 | - add/remove device in SQLite database
19 | - `/api/setup` (just mocked to accept any MAC address at present)
20 | - `/api/display` and associated BMP generation
21 | - docker built and [pushed to docker hub](https://hub.docker.com/r/stuartleeks/trmnl-plugin-tester) for x86 and ARM
22 |
23 | ## Live demo
24 | I have a live demo of this project running on [fly.io](https://trmnl-plugins.fly.dev/)
25 |
26 | ## Configuration Options
27 |
28 | The following configuration options are available in `config.js`:
29 |
30 | ### Paths
31 | - **`PLUGINS_PATH`**: Path to the plugins directory (default: `./_plugins`).
32 | - **`CACHE_PATH`**: Path to the cache directory (default: `./cache`). (NOTE: cache may be removed in future and could be broken)
33 |
34 | ### Feature Flags
35 | - **`ENABLE_IMAGE_GENERATION`**: Enable/disable image generation (default: `false`).
36 | - **`DEBUG_MODE`**: Enable debug mode for detailed logging (default: `false`).
37 | - **`ADMIN_MODE`**: Enable admin mode for additional BYOS features (default: `false`).
38 |
39 | ### Rate Limiting
40 | - **`MAX_REQUESTS_PER_5_MIN`**: Maximum number of requests allowed in 5 minutes (default: `400`).
41 |
42 | ### Server Config
43 | - **`PORT`**: Port for the server to listen on (default: `3000`).
44 |
45 | ### Browser Config
46 | - **`BROWSER_LAUNCH_CONFIG`**: Configuration for Puppeteer (e.g., sandbox, GPU, and memory settings).
47 |
48 |
49 | ### Image Generation
50 | - **`IMAGE_MAGICK_SWICTHES`**: ImageMagick options for converting images to BMP (default: `-dither FloydSteinberg -monochrome -depth 1 -strip -compress RLE -define bmp:format=bmp3`).
51 | - **`IMAGE_MAGICK_BIN`**: Path to the ImageMagick binary (default: `convert`).
52 |
53 | ### Derived Paths
54 | - **`FONTS_PATH`**: Path to fonts directory.
55 | - **`CSS_PATH`**: Path to CSS files.
56 | - **`JS_PATH`**: Path to JavaScript files.
57 |
58 | ## Getting Started
59 |
60 | ### Prerequisites
61 | - [Node.js](https://nodejs.org/) installed.
62 | - Git installed on your machine.
63 |
64 | ### Installation
65 | 1. Clone the repository:
66 | ```bash
67 | git clone https://github.com/gitstua/trmnl-plugin-dev.git
68 | cd trmnl-plugin-dev
69 | ```
70 |
71 | 2. Start the development server:
72 | ```bash
73 | ./scripts/run.sh
74 | ```
75 |
76 | This will start the server and provide the URL to open the preview in your browser.
77 |
78 | ## Docker Support
79 |
80 | You can run the TRMNL Plugin Tester using Docker:
81 |
82 | ### Using Docker in Development
83 | To build and run the image, use the following command:
84 | ```bash
85 | ./scripts/run-docker.sh
86 | ```
87 |
88 | ### Using Docker Hub Image
89 | The Docker image is built and pushed to Docker Hub for x86 and ARM architectures. You can pull it directly from [stuartleeks/trmnl-plugin-tester](https://hub.docker.com/r/stuartleeks/trmnl-plugin-tester).
90 |
91 | To run the image, use the following command:
92 | ```bash
93 | docker run -d -p 3000:3000 stuartleeks/trmnl-plugin-tester
94 | ```
95 |
96 | ## Plugin Configuration
97 |
98 | Each plugin requires a `settings.yml` file that defines how it works. This format is compatible with TRMNL's import/export functionality. Here's an example:
99 |
100 | ```yaml
101 | ---
102 | strategy: polling # polling, static, or webhook
103 | no_screen_padding: 'no' # yes/no - removes padding around the screen
104 | dark_mode: 'no' # yes/no - inverts colors for dark mode
105 | polling_verb: get # HTTP verb for polling strategy
106 | polling_url: https://api.example.com/data # URL to fetch data from
107 | polling_headers: 'content-type: application/json' # HTTP headers
108 | name: Example Plugin # Display name of the plugin
109 | description: Plugin description # Shown in plugin gallery
110 | refresh_interval: 3600 # Seconds between updates
111 |
112 | # Optional custom fields that users can configure
113 | custom_fields:
114 | - keyname: apikey # Internal field name
115 | field_type: string # string, number, select
116 | name: API Key # Display name
117 | description: Your API key # Help text
118 | placeholder: your-api-key # Example value
119 | ```
120 |
121 | The plugin should also include:
122 | - `views/` directory with Liquid templates for different layouts
123 | - `sample.json` for testing without live data
124 | - Optional `.env` file for secrets (add to .gitignore)
125 |
126 | ## Example Plugins
127 |
128 | ### Code Clock
129 | - Displays the time of image generation embedded in random code snippets.
130 | - **DATA**: Static snippets with dynamic time insertion.
131 | - **SOURCE**: [_plugins/code-clock](_plugins/code-clock).
132 | 
133 |
134 | ### Home Assistant TRMNL Plugin
135 | - Displays Home Assistant sensor data in TRMNL.
136 | - **DATA**: Home Assistant API.
137 | - **SOURCE**: [_plugins/home-assistant-trmnl](_plugins/home-assistant-trmnl).
138 | 
139 |
140 | ### NTFY Plugin
141 | - Displays periodic alerts from the [ntfy.sh](https://ntfy.sh/) notification service.
142 | - **DATA**: ntfy.sh API.
143 | - **SOURCE**: [_plugins/ntfy](_plugins/ntfy).
144 | 
145 |
146 | ### My Agenda
147 | - Shows upcoming events in an agenda view.
148 | - **DATA**: Custom API for converting ICAL to JSON.
149 | - **SOURCE**: [_plugins/my-agenda](_plugins/my-agenda).
150 | 
151 |
152 | ### Currency Exchange
153 | - Shows the current exchange rate for a currency pair.
154 | - **DATA**: [currencyapi.com](https://currencyapi.com/).
155 | - **SOURCE**: [_plugins/currency-exchange](_plugins/currency-exchange).
156 | 
157 |
158 | ### EPL Fixtures
159 | - Shows upcoming English Premier League fixtures.
160 | - **DATA**: [GitHub repo](https://github.com/openfootball).
161 | - **SOURCE**: [_plugins/epl-fixtures](_plugins/epl-fixtures).
162 | 
163 |
164 | ### Random Fact
165 | - Displays interesting random facts.
166 | - **DATA**: [uselessfacts.jsph.pl](https://uselessfacts.jsph.pl).
167 | - **SOURCE**: [_plugins/random-fact](_plugins/random-fact).
168 | 
169 |
170 | ### Random Joke
171 | - Shows setup and punchline of random jokes.
172 | - **DATA**: [official-joke-api.appspot.com](https://official-joke-api.appspot.com/random_joke).
173 | - **SOURCE**: [_plugins/random-joke](_plugins/random-joke).
174 | 
175 |
176 | ### Wind Speed & Direction
177 | - Displays hourly wind speed, direction, and gusts data.
178 | - **DATA**: Open-Meteo API.
179 | - **SOURCE**: [_plugins/wind-speed-direction](_plugins/wind-speed-direction).
180 | 
181 |
182 | ### TRMNL Broadcast
183 | - Displays custom messages and announcements.
184 | - **DATA**: Static JSON or custom webhook endpoint.
185 | - **SOURCE**: [_plugins/trmnl-broadcast](_plugins/trmnl-broadcast).
186 | 
187 |
188 | ## Credits / Acknowledgements
189 |
190 | This project would not have been possible without:
191 | - The [TRMNL](https://usetrmnl.com/) project.
192 | - [@schrockwell](https://github.com/schrockwell) for the [TRMNL Preview](https://github.com/schrockwell/trmnl_preview).
193 | - [LiquidJS](https://liquidjs.com) for the templating engine.
194 | - [ImageMagick](https://imagemagick.org/) for image conversion.
195 |
--------------------------------------------------------------------------------
4 | Basic Title Bar
5 | 
NTFY Alerts
23 | Topic: {{ trmnl.plugin_settings.custom_fields_values.topic_name }}
24 | 
35 | Plugin Title
36 | Instance Title
37 | 
12 |
13 | ## What is the NTFY Plugin?
14 |
15 | This plugin integrates with the ntfy service to display real-time alerts directly on your dashboard. It fetches notifications (alerts) and renders them using the TRMNL Design System, ensuring a consistent and clean interface across your application.
16 |
17 |
18 | 
19 |
20 |
21 |
22 | ### Key Features
23 |
24 | - **Periodic Notifications**: The plugin polls for the latest alerts and displays them as they arrive. Because the TRMNL device is an e-ink display, it will only update periodically conserving battery life.
25 |
26 | **REAL TIME NOTIFICATIONS ARE NOT SUPPORTED ON THE TRMNL DEVICE.**
27 |
28 | ## How to use the NTFY plugin
29 |
30 | There are many integrations for ntfy.sh, and you can use any of them to send messages to the topic.
31 |
32 | ### Web
33 |
34 | You can send messages to the topic using the ntfy.sh [web interface](https://ntfy.sh/trmnl-example12345/publish?title=Hello%20World&message=This%20is%20a%20test%20message)
35 |
36 | ### NTFY CLI
37 | You can send messages to the topic using the `ntfy` command line tool.
38 |
39 | ```bash
40 | ntfy publish --topic trmnl-example12345 --title "Hello World" --message "This is a test message"
41 | ```
42 |
43 | ### Curl
44 | ```bash
45 | curl -X POST https://ntfy.sh/trmnl-example12345/publish?title=Hello%20World&message=This%20is%20a%20test%20message
46 | ```
47 |
48 | ### Home Assistant
49 | You can [send messages to the topic from Home Assistant](https://docs.ntfy.sh/examples/#home-assistant) in the configuration.yaml file.
50 |
51 |
52 | ### Others
53 | There are many other integrations for ntfy.sh, and you can use any of them to send messages to the topic.
54 |
55 | See the [ntfy.sh examples](https://docs.ntfy.sh/examples/) for more information.
56 |
57 |
58 |
59 |
60 | This plugin provides a simple and effective way to monitor and display ntfy alerts, making it easier for you to stay updated with real-time notifications.
61 |
62 | Happy notifying!
63 |
--------------------------------------------------------------------------------
/_plugins/epl-fixtures/views/half_vertical.liquid:
--------------------------------------------------------------------------------
1 |
43 |
44 | 
21 |
22 | 
82 | Premier League
83 | Upcoming Fixtures
84 |