Skip to content

lanrat/trmnl_plugins

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A collection of custom plugins for TRMNL e-ink displays.

Overview

This repository contains various TRMNL plugins, each in its own directory. Each plugin directory includes a README.md file with detailed information about the plugin's functionality and configuration settings.

Development

Prerequisites

Setup

  1. Use the trmnlp.sh script to develop and test plugins:

    ./trmnlp.sh <plugin-directory> [command]

    On first run, the script will prompt you to enter your TRMNL API key and automatically create the trmnl.env file.

The script runs the TRMNL plugin development environment in Docker, mounting the specified plugin directory and making it available at http://localhost:4567.

Usage

Create a new plugin with:

 ./trmnlp.sh <new-plugin-dir-name> init

Run the development server:

 ./trmnlp.sh <plugin-directory> serve

Pull changes from TRMNL server:

 ./trmnlp.sh <plugin-directory> pull

Push changes to TRMNL server:

 ./trmnlp.sh <plugin-directory> push

Comic Plugin Generator

Some comic plugins are generated from shared templates using a Python-based code generator. See _generator/GENERATOR.md for details.

Debugging

Plugin in a Degraded State (Reset)

Misc

Dynamic Polling URLs