Download the PHP package bnussbau/laravel-trmnl without Composer
On this page you can find all versions of the php package bnussbau/laravel-trmnl. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bnussbau/laravel-trmnl
More information about bnussbau/laravel-trmnl
Files in bnussbau/laravel-trmnl
Package laravel-trmnl
Short Description Develop TRMNL plugins with Laravel
License MIT
Homepage https://github.com/bnussbau/laravel-trmnl
Informations about the package laravel-trmnl
Laravel TRMNL - Develop TRMNL plugins with Laravel
Laravel TRMNL is a package designed to streamline the development of both public and private plugins for the TRMNL E-ink device. It supports data updates via webhooks or polling. For public plugins, it also provides built-in support for the TRMNL OAuth flow. Additionally, UI prototyping is made easier with the included Blade components.
If you are looking for a Laravel based
- TRMNL Server implementation, check out this repo: usetrmnl/larapaper
- Blade Components on top of the TRMNL Design System, check out this repo: bnussbau/laravel-trmnl-blade
- streamlined package that converts HTML content (or images) into optimized images for e-paper devices: bnussbau/epaper-pipeline-php
Support ❤️
Support the development of this package by purchasing a TRMNL device through our referral link: https://trmnl.com/?ref=laravel-trmnl.
At checkout, use the code laravel-trmnl to receive a $15 discount on your purchase.
Plugins built with Laravel TRMNL
- trmnl-train-monitor by @bnussbau
Features
- 🔌 Public and private plugin support (docs), (docs)
- 🔄 Support for updates via webhooks or polling (docs)
- 🎨 Blade Components on top of the TRMNL Design System (docs)
- 🎯 OAuth integration support for public plugins (docs)
- 📱 Render Helpers for responsive layouts
Installation
You can install the package via composer:
Optional Steps
Publish Config
Optionally, publish the config file using:
Publish Views
Optionally, publish the views using:
Configuration
Default Environment Variables
The package can be configured through environment variables:
Plugin Development
Private Plugins
By default, plugins are private. To configure your settings, add the following environment variables to your .env file:
Update Data
Laravel TRMNL provides the UpdateScreenContentJob to facilitate sending data updates to TRMNL servers.
Example usage
Example using a Model and Pagination
Use the markup editor on the TRMNL private plugin webapp or use the stripMarkup() Method on the Trmnl
Facade to render markup which you can copy into the editor. See Section Blade Components.
Public Plugins
Refer to the “Plugin Marketplace” section in the TRMNL documentation, paying close attention to the authentication flow.
Always verify the authorization token for incoming requests to prevent security issues. You can use Auth::guard('trmnl') to verify.
Configuration
Publish & Run Migrations
Publishes the database table required for storing authentication data.
Render Markup
Public plugins need to provide a render endpoint, which returns markup for all screen layouts.
You can use the Trmnl::renderScreen() as helper.
Publish
Run command php artisan trmnl:plugin:configuration to print the URLs required for plugin submission.
Blade Components
Blade Compontens can help you generate markup code. Alternatively you can just use the native CSS classes from the TRMNL Design System.
Usage
Basic Layout
Quote Example
Testing
//: # ()
//: # ()
//: # ()
//: # ()
//: # ()
Credits
- Benjamin Nussbaum
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-trmnl with dependencies
bnussbau/laravel-trmnl-blade Version ^3.0.3
illuminate/contracts Version ^10.0||^11.0||^12.0||^13.0
spatie/laravel-package-tools Version ^1.18
voku/simple_html_dom Version ^5.0