mirror of
https://github.com/usetrmnl/byos_laravel.git
synced 2026-03-14 12:23:33 +00:00
Compare commits
7 commits
10effba08c
...
3abc67ff67
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3abc67ff67 | ||
|
|
9df538de16 | ||
|
|
ba541f62f1 | ||
|
|
26b5f3ceb1 | ||
|
|
c194ab5db1 | ||
|
|
d246ac2c59 | ||
|
|
d96fb297bc |
25 changed files with 597 additions and 361 deletions
5
.github/workflows/docker-build.yml
vendored
5
.github/workflows/docker-build.yml
vendored
|
|
@ -6,7 +6,6 @@ on:
|
|||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: ${{ github.repository }}
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
|
|
@ -40,7 +39,9 @@ jobs:
|
|||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||
images: |
|
||||
${{ env.REGISTRY }}/usetrmnl/byos_laravel
|
||||
${{ env.REGISTRY }}/usetrmnl/larapaper
|
||||
tags: |
|
||||
type=semver,pattern={{version}}
|
||||
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
########################
|
||||
FROM bnussbau/serversideup-php:8.4-fpm-nginx-alpine-imagick-chromium@sha256:ed705a4060d50143ddc538c1288afff217eaf76ad5791f7556a97943854cf745 AS base
|
||||
|
||||
LABEL org.opencontainers.image.source=https://github.com/usetrmnl/byos_laravel
|
||||
LABEL org.opencontainers.image.description="TRMNL BYOS Laravel"
|
||||
LABEL org.opencontainers.image.source=https://github.com/usetrmnl/larapaper
|
||||
LABEL org.opencontainers.image.description="LaraPaper"
|
||||
LABEL org.opencontainers.image.licenses=MIT
|
||||
|
||||
ARG APP_VERSION
|
||||
|
|
|
|||
22
README.md
22
README.md
|
|
@ -1,8 +1,8 @@
|
|||
## TRMNL BYOS (PHP/Laravel)
|
||||
## LaraPaper (PHP/Laravel)
|
||||
|
||||
[](https://github.com/usetrmnl/byos_laravel/actions/workflows/test.yml)
|
||||
[](https://github.com/usetrmnl/larapaper/actions/workflows/test.yml)
|
||||
|
||||
TRMNL BYOS Laravel is a self-hostable implementation of a TRMNL server, built with Laravel.
|
||||
LaraPaper is a self-hostable implementation of a TRMNL server (BYOS), built with Laravel.
|
||||
It allows you to manage TRMNL devices, generate screens using **native plugins** (Screens API, Markup), **recipes** (130+ from the [OSS community catalog](https://bnussbau.github.io/trmnl-recipe-catalog/), 700+ from the [TRMNL catalog](https://trmnl.com/recipes), or your own), or the **API**, and can also act as a **proxy** for the native cloud service (Core). With over 50k downloads and 200+ stars, it’s the most popular community-driven BYOS.
|
||||
|
||||

|
||||
|
|
@ -26,7 +26,7 @@ It allows you to manage TRMNL devices, generate screens using **native plugins**
|
|||
* Custom ESP32 with TRMNL firmware
|
||||
* E-Reader Devices
|
||||
* KOReader ([trmnl-koreader](https://github.com/usetrmnl/trmnl-koreader))
|
||||
* Kindle ([trmnl-kindle](https://github.com/usetrmnl/byos_laravel/pull/27))
|
||||
* Kindle ([trmnl-kindle](https://github.com/usetrmnl/larapaper/pull/27))
|
||||
* Nook ([trmnl-nook](https://github.com/usetrmnl/trmnl-nook))
|
||||
* Kobo ([trmnl-kobo](https://github.com/usetrmnl/trmnl-kobo))
|
||||
* Android Devices with [trmnl-android](https://github.com/usetrmnl/trmnl-android)
|
||||
|
|
@ -61,7 +61,7 @@ Docker Compose file located at: [docker/prod/docker-compose.yml](docker/prod/doc
|
|||
|
||||
##### Backup Database
|
||||
```sh
|
||||
docker ps #find container id of byos_laravel container
|
||||
docker ps #find container id of larapaper container
|
||||
docker cp {{CONTAINER_ID}}:/var/www/html/database/storage/database.sqlite database_backup.sqlite
|
||||
```
|
||||
|
||||
|
|
@ -73,11 +73,11 @@ docker compose up -d
|
|||
```
|
||||
|
||||
#### VPS
|
||||
If you’re using a VPS (e.g., Hetzner) and prefer an alternative to native Docker, you can install Dokploy and deploy BYOS Laravel using the integrated [Template](https://templates.dokploy.com/?q=trmnl+byos+laravel).
|
||||
If you’re using a VPS (e.g., Hetzner) and prefer an alternative to native Docker, you can install Dokploy and deploy LaraPaper using the integrated [Template](https://templates.dokploy.com/?q=trmnl+byos+laravel).
|
||||
It’s a quick way to get started without having to manually manage Docker setup.
|
||||
|
||||
#### PikaPods
|
||||
You can vote for TRMNL BYOS Laravel to be included as PikaPods Template here: [feedback.pikapods.com](https://feedback.pikapods.com/posts/842/add-app-trmnl-byos-laravel)
|
||||
You can vote for LaraPaper to be included as PikaPods Template here: [feedback.pikapods.com](https://feedback.pikapods.com/posts/842/add-app-trmnl-byos-laravel)
|
||||
|
||||
#### Umbrel
|
||||
Umbrel is supported through a community store, [see](http://github.com/bnussbau/umbrel-store).
|
||||
|
|
@ -173,13 +173,13 @@ See this YouTube guide: [https://www.youtube.com/watch?v=3xehPW-PCOM](https://ww
|
|||
### ☁️ Activate fresh TRMNL Device with Cloud Proxy
|
||||
|
||||
1) Setup the TRMNL as in the official docs with the cloud service (connect one of the plugins to later verify it works)
|
||||
2) Setup Laravel BYOS, create a user and login
|
||||
3) In Laravel BYOS in the header bar, activate the toggle "Permit Auto-Join"
|
||||
2) Setup LaraPaper, create a user and login
|
||||
3) In LaraPaper in the header bar, activate the toggle "Permit Auto-Join"
|
||||
4) Press and hold the button on the back of your TRMNL for 5 seconds to reactivate the captive portal (or reflash).
|
||||
5) Go through the setup process again, in the screen where you provide the Wi-Fi credentials there is also option to set the Server URL. Use the local address of your Laravel BYOS
|
||||
5) Go through the setup process again, in the screen where you provide the Wi-Fi credentials there is also option to set the Server URL. Use the local address of LaraPaper.
|
||||
6) The device should automatically appear in the device list; you can deactivate the "Permit Auto-Join" toggle again.
|
||||
7) In the devices list, activate the toggle "☁️ Proxy" for your device. (Make sure that the queue worker is active. In the docker image it should be running automatically.)
|
||||
8) As long as no Laravel BYOS plugin is scheduled, the device will show your cloud plugins.
|
||||
8) As long as no LaraPaper plugin is scheduled, the device will show your cloud plugins.
|
||||
|
||||
###### Troubleshooting
|
||||
|
||||
|
|
|
|||
|
|
@ -34,8 +34,13 @@ class GenerateScreenJob implements ShouldQueue
|
|||
Device::find($this->deviceId)->update(['current_screen_image' => $newImageUuid]);
|
||||
|
||||
if ($this->pluginId) {
|
||||
// cache current image
|
||||
Plugin::find($this->pluginId)->update(['current_image' => $newImageUuid]);
|
||||
$plugin = Plugin::find($this->pluginId);
|
||||
$update = ['current_image' => $newImageUuid];
|
||||
if ($plugin->plugin_type === 'recipe') {
|
||||
$device = Device::with(['deviceModel', 'deviceModel.palette'])->find($this->deviceId);
|
||||
$update['current_image_metadata'] = ImageGenerationService::buildImageMetadataFromDevice($device);
|
||||
}
|
||||
$plugin->update($update);
|
||||
}
|
||||
|
||||
ImageGenerationService::cleanupFolder();
|
||||
|
|
|
|||
|
|
@ -49,6 +49,7 @@ class Plugin extends Model
|
|||
'preferred_renderer' => 'string',
|
||||
'plugin_type' => 'string',
|
||||
'alias' => 'boolean',
|
||||
'current_image_metadata' => 'array',
|
||||
];
|
||||
|
||||
protected static function boot()
|
||||
|
|
@ -71,6 +72,7 @@ class Plugin extends Model
|
|||
'render_markup_shared',
|
||||
])) {
|
||||
$model->current_image = null;
|
||||
$model->current_image_metadata = null;
|
||||
}
|
||||
});
|
||||
|
||||
|
|
@ -222,7 +224,7 @@ class Plugin extends Model
|
|||
if ($this->data_strategy !== 'polling' || ! $this->polling_url) {
|
||||
return;
|
||||
}
|
||||
$headers = ['User-Agent' => 'usetrmnl/byos_laravel', 'Accept' => 'application/json'];
|
||||
$headers = ['User-Agent' => 'usetrmnl/larapaper', 'Accept' => 'application/json'];
|
||||
|
||||
// resolve headers
|
||||
if ($this->polling_header) {
|
||||
|
|
|
|||
|
|
@ -331,36 +331,88 @@ class ImageGenerationService
|
|||
}
|
||||
}
|
||||
|
||||
public static function resetIfNotCacheable(?Plugin $plugin): void
|
||||
/**
|
||||
* Ensure plugin image cache is valid for the current context. No-op for image_webhook.
|
||||
* When deviceOrModel is provided (recipe only), clears cache if stored metadata does not match.
|
||||
*/
|
||||
public static function resetIfNotCacheable(?Plugin $plugin, Device|DeviceModel|null $deviceOrModel = null): void
|
||||
{
|
||||
if ($plugin?->id) {
|
||||
// Image webhook plugins have finalized images that shouldn't be reset
|
||||
if ($plugin->plugin_type === 'image_webhook') {
|
||||
return;
|
||||
}
|
||||
// Check if any devices have custom dimensions or use non-standard DeviceModels
|
||||
$hasCustomDimensions = Device::query()
|
||||
->where(function ($query): void {
|
||||
$query->where('width', '!=', 800)
|
||||
->orWhere('height', '!=', 480)
|
||||
->orWhere('rotate', '!=', 0);
|
||||
})
|
||||
->orWhereHas('deviceModel', function ($query): void {
|
||||
// Only allow caching if all device models have standard dimensions (800x480, rotation=0)
|
||||
$query->where(function ($subQuery): void {
|
||||
$subQuery->where('width', '!=', 800)
|
||||
->orWhere('height', '!=', 480)
|
||||
->orWhere('rotation', '!=', 0);
|
||||
});
|
||||
})
|
||||
->exists();
|
||||
if (! $plugin?->id || $plugin->plugin_type === 'image_webhook') {
|
||||
return;
|
||||
}
|
||||
if ($deviceOrModel === null || $plugin->plugin_type !== 'recipe') {
|
||||
return;
|
||||
}
|
||||
if ($plugin->current_image === null) {
|
||||
return;
|
||||
}
|
||||
if (self::imageMetadataMatches($plugin->current_image_metadata, $deviceOrModel)) {
|
||||
return;
|
||||
}
|
||||
$plugin->update([
|
||||
'current_image' => null,
|
||||
'current_image_metadata' => null,
|
||||
]);
|
||||
Log::debug("Plugin {$plugin->id}: cleared image cache due to metadata mismatch");
|
||||
}
|
||||
|
||||
if ($hasCustomDimensions) {
|
||||
// TODO cache image per device
|
||||
$plugin->update(['current_image' => null]);
|
||||
Log::debug('Skip cache as devices with custom dimensions or non-standard DeviceModels exist');
|
||||
/**
|
||||
* Build canonical image metadata from a Device for cache comparison.
|
||||
*
|
||||
* @return array{width: int, height: int, rotation: int, palette_id: int|null, mime_type: string}
|
||||
*/
|
||||
public static function buildImageMetadataFromDevice(Device $device): array
|
||||
{
|
||||
$device->loadMissing(['deviceModel', 'deviceModel.palette']);
|
||||
$settings = self::getImageSettings($device);
|
||||
$paletteId = $device->palette_id ?? $device->deviceModel?->palette_id;
|
||||
|
||||
return [
|
||||
'width' => $settings['width'],
|
||||
'height' => $settings['height'],
|
||||
'rotation' => $settings['rotation'] ?? 0,
|
||||
'palette_id' => $paletteId,
|
||||
'mime_type' => $settings['mime_type'],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Build canonical image metadata from a DeviceModel for cache comparison.
|
||||
*
|
||||
* @return array{width: int, height: int, rotation: int, palette_id: int|null, mime_type: string}
|
||||
*/
|
||||
public static function buildImageMetadataFromDeviceModel(DeviceModel $model): array
|
||||
{
|
||||
return [
|
||||
'width' => $model->width,
|
||||
'height' => $model->height,
|
||||
'rotation' => $model->rotation ?? 0,
|
||||
'palette_id' => $model->palette_id,
|
||||
'mime_type' => $model->mime_type,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if stored metadata matches the current device or device model.
|
||||
* Returns false if stored is null or empty so cache is regenerated and metadata is stored.
|
||||
*/
|
||||
public static function imageMetadataMatches(?array $stored, Device|DeviceModel $deviceOrModel): bool
|
||||
{
|
||||
if ($stored === null || $stored === []) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$current = $deviceOrModel instanceof Device
|
||||
? self::buildImageMetadataFromDevice($deviceOrModel)
|
||||
: self::buildImageMetadataFromDeviceModel($deviceOrModel);
|
||||
|
||||
foreach (['width', 'height', 'rotation', 'palette_id', 'mime_type'] as $key) {
|
||||
if (($stored[$key] ?? null) !== ($current[$key] ?? null)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
435
composer.lock
generated
435
composer.lock
generated
File diff suppressed because it is too large
Load diff
|
|
@ -13,7 +13,7 @@ return [
|
|||
|
|
||||
*/
|
||||
|
||||
'name' => env('APP_NAME', 'Laravel'),
|
||||
'name' => env('APP_NAME', 'LaraPaper'),
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
@ -127,6 +127,8 @@ return [
|
|||
'enabled' => env('REGISTRATION_ENABLED', true),
|
||||
],
|
||||
|
||||
'pixel_logo_enabled' => env('PIXELLOGO_ENABLED', true),
|
||||
|
||||
'force_https' => env('FORCE_HTTPS', false),
|
||||
'puppeteer_docker' => env('PUPPETEER_DOCKER', false),
|
||||
'puppeteer_mode' => env('PUPPETEER_MODE', 'local'),
|
||||
|
|
@ -154,5 +156,5 @@ return [
|
|||
|
||||
'catalog_url' => env('CATALOG_URL', 'https://raw.githubusercontent.com/bnussbau/trmnl-recipe-catalog/refs/heads/main/catalog.yaml'),
|
||||
|
||||
'github_repo' => env('GITHUB_REPO', 'usetrmnl/byos_laravel'),
|
||||
'github_repo' => env('GITHUB_REPO', 'usetrmnl/larapaper'),
|
||||
];
|
||||
|
|
|
|||
|
|
@ -0,0 +1,28 @@
|
|||
<?php
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
return new class extends Migration
|
||||
{
|
||||
/**
|
||||
* Run the migrations.
|
||||
*/
|
||||
public function up(): void
|
||||
{
|
||||
Schema::table('plugins', function (Blueprint $table) {
|
||||
$table->json('current_image_metadata')->nullable()->after('current_image');
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Reverse the migrations.
|
||||
*/
|
||||
public function down(): void
|
||||
{
|
||||
Schema::table('plugins', function (Blueprint $table) {
|
||||
$table->dropColumn('current_image_metadata');
|
||||
});
|
||||
}
|
||||
};
|
||||
|
|
@ -3,6 +3,7 @@
|
|||
namespace Database\Seeders;
|
||||
|
||||
use App\Models\Device;
|
||||
use App\Models\Playlist;
|
||||
use App\Models\Plugin;
|
||||
use App\Models\User;
|
||||
use Illuminate\Database\Seeder;
|
||||
|
|
@ -23,9 +24,19 @@ class DatabaseSeeder extends Seeder
|
|||
'password' => bcrypt('admin@example.com'),
|
||||
]);
|
||||
|
||||
Device::factory(1)->create([
|
||||
$device = Device::factory()->create([
|
||||
'mac_address' => '00:00:00:00:00:00',
|
||||
'api_key' => 'test-api-key',
|
||||
'proxy_cloud' => false,
|
||||
]);
|
||||
|
||||
Playlist::factory()->create([
|
||||
'device_id' => $device->id,
|
||||
'name' => 'Default',
|
||||
'is_active' => true,
|
||||
'active_from' => null,
|
||||
'active_until' => null,
|
||||
'weekdays' => null
|
||||
]);
|
||||
|
||||
// Device::factory(5)->create();
|
||||
|
|
|
|||
|
|
@ -1,9 +1,10 @@
|
|||
services:
|
||||
app:
|
||||
image: ghcr.io/usetrmnl/byos_laravel:latest
|
||||
image: ghcr.io/usetrmnl/larapaper:latest
|
||||
ports:
|
||||
- "4567:8080"
|
||||
environment:
|
||||
# Generate the APP_KEY with `echo "base64:$(openssl rand -base64 32)"`
|
||||
#- APP_KEY=
|
||||
- PHP_OPCACHE_ENABLE=1
|
||||
- TRMNL_PROXY_REFRESH_MINUTES=15
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
#### Clone the repository
|
||||
|
||||
```bash
|
||||
git clone git@github.com:usetrmnl/byos_laravel.git
|
||||
git clone git@github.com:usetrmnl/larapaper.git
|
||||
```
|
||||
|
||||
#### Copy environment file
|
||||
|
|
|
|||
|
|
@ -2,5 +2,9 @@
|
|||
<x-app-logo-icon class="size-5 fill-current text-white dark:text-black" />
|
||||
</div>
|
||||
<div class="ml-1 grid flex-1 text-left text-sm">
|
||||
<span class="mb-0.5 truncate leading-none font-semibold">TRMNL BYOS Laravel</span>
|
||||
@if(config('app.pixel_logo_enabled'))
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="h-7 pt-1.5 dark:fill-white" viewBox="0 0 1000 150"><path fill-rule="evenodd" d="M894.75 119.01V47.28h16.1V31.54h55.63v15.74h16.29v24.7h-23.43V56.43H918V119Zm-90.59 0v-15.55h-16.1V47.28h16.1V31.54h55.63v15.74h16.29v24.7h-23.42V56.43H811.3v6.22h32.39v25.07h-32.4v6.4h41.37V78.2h23.42v25.07h-16.29v15.74Zm-122.8 30.38V47.28h16.11V31.54h55.63v15.74h16.3v56.18h-16.38V119H704.6v30.4Zm23.25-55.26h41.36v-37.7H704.6ZM574.5 119v-15.55h-16.1V47.28h16.1V31.54h55.63v15.73h16.37v46.85h16.2v24.9h-23.42v-15.56h-9.15V119Zm7.13-24.89H623v-37.7h-41.36Zm-124.44 24.9V15.97h16.1V.25h55.64v15.73h16.29v56h-16.38v15.74h-48.4v31.3Zm23.24-56.37h41.36V25.32h-41.36ZM357.64 119v-15.55h-16.1V47.28h16.1V31.54h55.63v15.73h16.38v46.85h16.2v24.9h-23.43v-15.56h-9.15V119Zm7.14-24.89h41.36v-37.7h-41.36Zm-124.44 24.9V47.27h16.1V31.54h55.63v15.74h16.3v24.7h-23.43V56.43h-41.36V119Zm-106.87 0v-15.56h-16.1V47.28h16.1V31.54h55.63v15.73h16.37v46.85h16.2v24.9h-23.42v-15.56h-9.15V119Zm7.13-24.9h41.36v-37.7H140.6Zm-108.33 24.9v-15.56h-16.1V.25H39.4v93.88h41.36V78.39h23.43v25.07h-16.3V119Z"/></svg>
|
||||
@else
|
||||
<span class="mb-0.5 truncate leading-none font-semibold">LaraPaper</span>
|
||||
@endif
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -4,6 +4,10 @@
|
|||
])
|
||||
|
||||
<div class="flex w-full flex-col text-center">
|
||||
<flux:heading size="xl">{{ $title }}</flux:heading>
|
||||
@if(config('app.pixel_logo_enabled'))
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="h-8 dark:fill-white" viewBox="0 0 1000 150"><path fill-rule="evenodd" d="M894.75 119.01V47.28h16.1V31.54h55.63v15.74h16.29v24.7h-23.43V56.43H918V119Zm-90.59 0v-15.55h-16.1V47.28h16.1V31.54h55.63v15.74h16.29v24.7h-23.42V56.43H811.3v6.22h32.39v25.07h-32.4v6.4h41.37V78.2h23.42v25.07h-16.29v15.74Zm-122.8 30.38V47.28h16.11V31.54h55.63v15.74h16.3v56.18h-16.38V119H704.6v30.4Zm23.25-55.26h41.36v-37.7H704.6ZM574.5 119v-15.55h-16.1V47.28h16.1V31.54h55.63v15.73h16.37v46.85h16.2v24.9h-23.42v-15.56h-9.15V119Zm7.13-24.89H623v-37.7h-41.36Zm-124.44 24.9V15.97h16.1V.25h55.64v15.73h16.29v56h-16.38v15.74h-48.4v31.3Zm23.24-56.37h41.36V25.32h-41.36ZM357.64 119v-15.55h-16.1V47.28h16.1V31.54h55.63v15.73h16.38v46.85h16.2v24.9h-23.43v-15.56h-9.15V119Zm7.14-24.89h41.36v-37.7h-41.36Zm-124.44 24.9V47.27h16.1V31.54h55.63v15.74h16.3v24.7h-23.43V56.43h-41.36V119Zm-106.87 0v-15.56h-16.1V47.28h16.1V31.54h55.63v15.73h16.37v46.85h16.2v24.9h-23.42v-15.56h-9.15V119Zm7.13-24.9h41.36v-37.7H140.6Zm-108.33 24.9v-15.56h-16.1V.25H39.4v93.88h41.36V78.39h23.43v25.07h-16.3V119Z"/></svg>
|
||||
@else
|
||||
<flux:heading size="xl">LaraPaper</flux:heading>
|
||||
@endif
|
||||
<flux:subheading>{{ $description }}</flux:subheading>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -15,10 +15,10 @@
|
|||
<x-trmnl::view>
|
||||
<x-trmnl::layout>
|
||||
<x-trmnl::richtext gapSize="large" align="center">
|
||||
<x-trmnl::title>Welcome to BYOS Laravel!</x-trmnl::title>
|
||||
<x-trmnl::title>Welcome to LaraPaper!</x-trmnl::title>
|
||||
<x-trmnl::content>Your device is connected.</x-trmnl::content>
|
||||
</x-trmnl::richtext>
|
||||
</x-trmnl::layout>
|
||||
<x-trmnl::title-bar title="byos_laravel"/>
|
||||
<x-trmnl::title-bar title="LaraPaper"/>
|
||||
</x-trmnl::view>
|
||||
</x-trmnl::screen>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,6 @@
|
|||
<x-trmnl::title>Sleep Mode</x-trmnl::title>
|
||||
</x-trmnl::richtext>
|
||||
</x-trmnl::layout>
|
||||
<x-trmnl::title-bar title="byos_laravel"/>
|
||||
<x-trmnl::title-bar title="LaraPaper"/>
|
||||
</x-trmnl::view>
|
||||
</x-trmnl::screen>
|
||||
|
|
|
|||
|
|
@ -264,7 +264,7 @@ new class extends Component
|
|||
{{-- <li><flux:text><code>date: "%N"</code> is unsupported. Use <code>date: "u"</code> instead </flux:text></li>--}}
|
||||
{{-- </ul>--}}
|
||||
</ul>
|
||||
<flux:text class="mt-1">Please report <a href="https://github.com/usetrmnl/byos_laravel/issues/new" target="_blank" class="underline">issues on GitHub</a>. Include your example zip file.</flux:text></li>
|
||||
<flux:text class="mt-1">Please report <a href="https://github.com/usetrmnl/larapaper/issues/new" target="_blank" class="underline">issues on GitHub</a>. Include your example zip file.</flux:text></li>
|
||||
</div>
|
||||
|
||||
<form wire:submit="importZip">
|
||||
|
|
@ -315,7 +315,7 @@ new class extends Component
|
|||
<li><flux:text>API responses in formats other than <span class="font-mono">JSON</span> are not yet fully supported.</flux:text></li>
|
||||
<li><flux:text>There are limitations in payload size (Data Payload, Template).</flux:text></li>
|
||||
</ul>
|
||||
<flux:text class="mt-1">Please report issues, aside from the known limitations, on <a href="https://github.com/usetrmnl/byos_laravel/issues/new" target="_blank" class="underline">GitHub</a>. Include the recipe URL.</flux:text></li>
|
||||
<flux:text class="mt-1">Please report issues, aside from the known limitations, on <a href="https://github.com/usetrmnl/larapaper/issues/new" target="_blank" class="underline">GitHub</a>. Include the recipe URL.</flux:text></li>
|
||||
</flux:callout>
|
||||
</div>
|
||||
<livewire:catalog.trmnl />
|
||||
|
|
|
|||
|
|
@ -72,8 +72,8 @@ new class extends Component
|
|||
<x-trmnl::view>
|
||||
<x-trmnl::layout>
|
||||
<x-trmnl::richtext gapSize="large" align="center">
|
||||
<x-trmnl::title>TRMNL BYOS Laravel</x-trmnl::title>
|
||||
<x-trmnl::content>“This screen was rendered by BYOS Laravel”</x-trmnl::content>
|
||||
<x-trmnl::title>LaraPaper</x-trmnl::title>
|
||||
<x-trmnl::content>“This screen was rendered by BYOS LaraPaper”</x-trmnl::content>
|
||||
<x-trmnl::label variant="underline">Benjamin Nussbaum</x-trmnl::label>
|
||||
</x-trmnl::richtext>
|
||||
</x-trmnl::layout>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>{{ $title ?? 'TRMNL BYOS Laravel' }}</title>
|
||||
<title>{{ $title ?? 'LaraPaper' }}</title>
|
||||
|
||||
<link rel="preconnect" href="https://fonts.bunny.net">
|
||||
<link href="https://fonts.bunny.net/css?family=inter:400,500,600&display=swap" rel="stylesheet" />
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<x-layouts::auth.card>
|
||||
<div class="flex flex-col gap-6">
|
||||
<x-auth-header title="TRMNL BYOS Laravel" description="Server is up and running."/>
|
||||
<x-auth-header title="LaraPaper" description="Server is up and running."/>
|
||||
</div>
|
||||
<header class="w-full lg:max-w-4xl max-w-[335px] text-sm mt-6 not-has-[nav]:hidden">
|
||||
@if (Route::has('login'))
|
||||
|
|
@ -33,7 +33,7 @@
|
|||
</header>
|
||||
@auth
|
||||
@if(config('app.version'))
|
||||
<flux:text class="text-xs">Version: <a href="https://github.com/usetrmnl/byos_laravel/releases/tag/{{ config('app.version') }}"
|
||||
<flux:text class="text-xs">Version: <a href="https://github.com/{{ config('app.github_repo') }}/releases/tag/{{ config('app.version') }}"
|
||||
target="_blank">{{ config('app.version') }}</a>
|
||||
</flux:text>
|
||||
@endif
|
||||
|
|
|
|||
|
|
@ -88,8 +88,8 @@ Route::get('/display', function (Request $request) {
|
|||
$refreshTimeOverride = $playlistItem->playlist()->first()->refresh_time;
|
||||
$plugin = $playlistItem->plugin;
|
||||
|
||||
// Reset cache if Devices with different dimensions exist
|
||||
ImageGenerationService::resetIfNotCacheable($plugin);
|
||||
ImageGenerationService::resetIfNotCacheable($plugin, $device);
|
||||
$plugin->refresh();
|
||||
|
||||
// Check and update stale data if needed
|
||||
if ($plugin->isDataStale() || $plugin->current_image === null) {
|
||||
|
|
@ -699,6 +699,9 @@ Route::get('/display/{uuid}/alias', function (Request $request, string $uuid) {
|
|||
], 404);
|
||||
}
|
||||
|
||||
ImageGenerationService::resetIfNotCacheable($plugin, $deviceModel);
|
||||
$plugin->refresh();
|
||||
|
||||
// Check if we can use cached image (only for og_png and if data is not stale)
|
||||
$useCache = $deviceModelName === 'og_png' && ! $plugin->isDataStale() && $plugin->current_image !== null;
|
||||
|
||||
|
|
@ -744,9 +747,13 @@ Route::get('/display/{uuid}/alias', function (Request $request, string $uuid) {
|
|||
palette: $deviceModel->palette
|
||||
);
|
||||
|
||||
// Update plugin cache if using og_png
|
||||
// Update plugin cache if using og_png (recipes only get metadata for cache comparison)
|
||||
if ($deviceModelName === 'og_png') {
|
||||
$plugin->update(['current_image' => $imageUuid]);
|
||||
$update = ['current_image' => $imageUuid];
|
||||
if ($plugin->plugin_type === 'recipe') {
|
||||
$update['current_image_metadata'] = ImageGenerationService::buildImageMetadataFromDeviceModel($deviceModel);
|
||||
}
|
||||
$plugin->update($update);
|
||||
}
|
||||
|
||||
// Return the generated image
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
use App\Jobs\GenerateScreenJob;
|
||||
use App\Models\Device;
|
||||
use App\Models\DeviceModel;
|
||||
use App\Models\Plugin;
|
||||
use Bnussbau\TrmnlPipeline\TrmnlPipeline;
|
||||
use Illuminate\Support\Facades\Storage;
|
||||
|
||||
|
|
@ -58,3 +60,26 @@ test('it preserves gitignore file during cleanup', function (): void {
|
|||
|
||||
Storage::disk('public')->assertExists('/images/generated/.gitignore');
|
||||
});
|
||||
|
||||
test('it saves current_image_metadata for recipe plugins', function (): void {
|
||||
$deviceModel = DeviceModel::factory()->create([
|
||||
'width' => 800,
|
||||
'height' => 480,
|
||||
'rotation' => 0,
|
||||
'mime_type' => 'image/png',
|
||||
'palette_id' => null,
|
||||
]);
|
||||
$device = Device::factory()->create(['device_model_id' => $deviceModel->id]);
|
||||
$plugin = Plugin::factory()->create(['plugin_type' => 'recipe']);
|
||||
|
||||
$job = new GenerateScreenJob($device->id, $plugin->id, '<div>Test</div>');
|
||||
$job->handle();
|
||||
|
||||
$plugin->refresh();
|
||||
expect($plugin->current_image)->not->toBeNull();
|
||||
expect($plugin->current_image_metadata)->toBeArray();
|
||||
expect($plugin->current_image_metadata)->toHaveKeys(['width', 'height', 'rotation', 'palette_id', 'mime_type']);
|
||||
expect($plugin->current_image_metadata['width'])->toBe(800);
|
||||
expect($plugin->current_image_metadata['height'])->toBe(480);
|
||||
expect($plugin->current_image_metadata['mime_type'])->toBe('image/png');
|
||||
});
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ use App\Models\DeviceModel;
|
|||
use App\Services\ImageGenerationService;
|
||||
use Bnussbau\TrmnlPipeline\TrmnlPipeline;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
use Illuminate\Support\Facades\Storage;
|
||||
|
||||
uses(RefreshDatabase::class);
|
||||
|
|
@ -22,6 +23,10 @@ afterEach(function (): void {
|
|||
TrmnlPipeline::restore();
|
||||
});
|
||||
|
||||
it('plugins table has current_image_metadata column', function (): void {
|
||||
expect(Schema::hasColumn('plugins', 'current_image_metadata'))->toBeTrue();
|
||||
});
|
||||
|
||||
it('generates image for device without device model', function (): void {
|
||||
// Create a device without a DeviceModel (legacy behavior)
|
||||
$device = Device::factory()->create([
|
||||
|
|
@ -270,39 +275,15 @@ it('cleanupFolder preserves .gitignore', function (): void {
|
|||
Storage::disk('public')->assertExists('/images/generated/.gitignore');
|
||||
});
|
||||
|
||||
it('resetIfNotCacheable resets when device models exist', function (): void {
|
||||
// Create a plugin
|
||||
$plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
|
||||
it('resetIfNotCacheable does not reset recipe cache based on other devices', function (): void {
|
||||
// Cache validity is now determined at use-time via current_image_metadata
|
||||
$plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid', 'plugin_type' => 'recipe']);
|
||||
|
||||
// Create a device with DeviceModel (should trigger cache reset)
|
||||
Device::factory()->create([
|
||||
'device_model_id' => DeviceModel::factory()->create()->id,
|
||||
]);
|
||||
|
||||
// Run reset check
|
||||
Device::factory()->create(['device_model_id' => DeviceModel::factory()->create()->id]);
|
||||
ImageGenerationService::resetIfNotCacheable($plugin);
|
||||
|
||||
// Assert plugin image was reset
|
||||
$plugin->refresh();
|
||||
expect($plugin->current_image)->toBeNull();
|
||||
});
|
||||
|
||||
it('resetIfNotCacheable resets when custom dimensions exist', function (): void {
|
||||
// Create a plugin
|
||||
$plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
|
||||
|
||||
// Create a device with custom dimensions (should trigger cache reset)
|
||||
Device::factory()->create([
|
||||
'width' => 1024, // Different from default 800
|
||||
'height' => 768, // Different from default 480
|
||||
]);
|
||||
|
||||
// Run reset check
|
||||
ImageGenerationService::resetIfNotCacheable($plugin);
|
||||
|
||||
// Assert plugin image was reset
|
||||
$plugin->refresh();
|
||||
expect($plugin->current_image)->toBeNull();
|
||||
expect($plugin->current_image)->toBe('test-uuid');
|
||||
});
|
||||
|
||||
it('resetIfNotCacheable preserves image for standard devices', function (): void {
|
||||
|
|
@ -325,27 +306,122 @@ it('resetIfNotCacheable preserves image for standard devices', function (): void
|
|||
});
|
||||
|
||||
it('cache is reset when plugin markup changes', function (): void {
|
||||
// Create a plugin with cached image
|
||||
// Create a plugin with cached image and metadata
|
||||
$plugin = App\Models\Plugin::factory()->create([
|
||||
'current_image' => 'cached-uuid',
|
||||
'current_image_metadata' => ['width' => 800, 'height' => 480, 'rotation' => 0, 'palette_id' => null, 'mime_type' => 'image/png'],
|
||||
'render_markup' => '<div>Original markup</div>',
|
||||
]);
|
||||
|
||||
// Create devices with standard dimensions (cacheable)
|
||||
Device::factory()->count(2)->create([
|
||||
'width' => 800,
|
||||
'height' => 480,
|
||||
'rotate' => 0,
|
||||
]);
|
||||
$plugin->update(['render_markup' => '<div>Updated markup</div>']);
|
||||
|
||||
// Update the plugin markup
|
||||
$plugin->update([
|
||||
'render_markup' => '<div>Updated markup</div>',
|
||||
]);
|
||||
|
||||
// Assert cache was reset when markup changed
|
||||
$plugin->refresh();
|
||||
expect($plugin->current_image)->toBeNull();
|
||||
expect($plugin->current_image_metadata)->toBeNull();
|
||||
});
|
||||
|
||||
it('buildImageMetadataFromDevice returns canonical metadata shape', function (): void {
|
||||
$deviceModel = DeviceModel::factory()->create([
|
||||
'width' => 800,
|
||||
'height' => 480,
|
||||
'rotation' => 0,
|
||||
'mime_type' => 'image/png',
|
||||
'palette_id' => null,
|
||||
]);
|
||||
$device = Device::factory()->create(['device_model_id' => $deviceModel->id]);
|
||||
|
||||
$meta = ImageGenerationService::buildImageMetadataFromDevice($device);
|
||||
|
||||
expect($meta)->toHaveKeys(['width', 'height', 'rotation', 'palette_id', 'mime_type']);
|
||||
expect($meta['width'])->toBe(800);
|
||||
expect($meta['height'])->toBe(480);
|
||||
expect($meta['rotation'])->toBe(0);
|
||||
expect($meta['mime_type'])->toBe('image/png');
|
||||
});
|
||||
|
||||
it('buildImageMetadataFromDeviceModel returns canonical metadata shape', function (): void {
|
||||
$model = DeviceModel::factory()->create([
|
||||
'width' => 1024,
|
||||
'height' => 768,
|
||||
'rotation' => 90,
|
||||
'mime_type' => 'image/bmp',
|
||||
'palette_id' => null,
|
||||
]);
|
||||
|
||||
$meta = ImageGenerationService::buildImageMetadataFromDeviceModel($model);
|
||||
|
||||
expect($meta)->toHaveKeys(['width', 'height', 'rotation', 'palette_id', 'mime_type']);
|
||||
expect($meta['width'])->toBe(1024);
|
||||
expect($meta['height'])->toBe(768);
|
||||
expect($meta['rotation'])->toBe(90);
|
||||
expect($meta['mime_type'])->toBe('image/bmp');
|
||||
});
|
||||
|
||||
it('imageMetadataMatches returns false when stored is null or empty', function (): void {
|
||||
$device = Device::factory()->create(['width' => 800, 'height' => 480, 'rotate' => 0]);
|
||||
|
||||
expect(ImageGenerationService::imageMetadataMatches(null, $device))->toBeFalse();
|
||||
expect(ImageGenerationService::imageMetadataMatches([], $device))->toBeFalse();
|
||||
});
|
||||
|
||||
it('imageMetadataMatches returns true when metadata matches device', function (): void {
|
||||
$deviceModel = DeviceModel::factory()->create([
|
||||
'width' => 800,
|
||||
'height' => 480,
|
||||
'rotation' => 0,
|
||||
'mime_type' => 'image/png',
|
||||
'palette_id' => null,
|
||||
]);
|
||||
$device = Device::factory()->create(['device_model_id' => $deviceModel->id]);
|
||||
$stored = ImageGenerationService::buildImageMetadataFromDevice($device);
|
||||
|
||||
expect(ImageGenerationService::imageMetadataMatches($stored, $device))->toBeTrue();
|
||||
});
|
||||
|
||||
it('imageMetadataMatches returns false when metadata differs', function (): void {
|
||||
$device = Device::factory()->create(['width' => 800, 'height' => 480, 'rotate' => 0]);
|
||||
$stored = ['width' => 800, 'height' => 480, 'rotation' => 0, 'palette_id' => null, 'mime_type' => 'image/png'];
|
||||
|
||||
$device->update(['width' => 1024]);
|
||||
$device->refresh();
|
||||
|
||||
expect(ImageGenerationService::imageMetadataMatches($stored, $device))->toBeFalse();
|
||||
});
|
||||
|
||||
it('resetIfNotCacheable clears recipe cache when metadata does not match', function (): void {
|
||||
$plugin = App\Models\Plugin::factory()->create([
|
||||
'plugin_type' => 'recipe',
|
||||
'current_image' => 'cached-uuid',
|
||||
'current_image_metadata' => ['width' => 800, 'height' => 480, 'rotation' => 0, 'palette_id' => null, 'mime_type' => 'image/png'],
|
||||
]);
|
||||
$device = Device::factory()->create(['width' => 1024, 'height' => 768, 'rotate' => 0]);
|
||||
|
||||
ImageGenerationService::resetIfNotCacheable($plugin, $device);
|
||||
|
||||
$plugin->refresh();
|
||||
expect($plugin->current_image)->toBeNull();
|
||||
expect($plugin->current_image_metadata)->toBeNull();
|
||||
});
|
||||
|
||||
it('resetIfNotCacheable preserves cache when metadata matches', function (): void {
|
||||
$deviceModel = DeviceModel::factory()->create([
|
||||
'width' => 800,
|
||||
'height' => 480,
|
||||
'rotation' => 0,
|
||||
'mime_type' => 'image/png',
|
||||
]);
|
||||
$device = Device::factory()->create(['device_model_id' => $deviceModel->id]);
|
||||
$meta = ImageGenerationService::buildImageMetadataFromDevice($device);
|
||||
$plugin = App\Models\Plugin::factory()->create([
|
||||
'plugin_type' => 'recipe',
|
||||
'current_image' => 'cached-uuid',
|
||||
'current_image_metadata' => $meta,
|
||||
]);
|
||||
|
||||
ImageGenerationService::resetIfNotCacheable($plugin, $device);
|
||||
|
||||
$plugin->refresh();
|
||||
expect($plugin->current_image)->toBe('cached-uuid');
|
||||
});
|
||||
|
||||
it('determines correct image format from device model', function (): void {
|
||||
|
|
|
|||
46
tests/Feature/PixelLogoConfigTest.php
Normal file
46
tests/Feature/PixelLogoConfigTest.php
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
<?php
|
||||
|
||||
use App\Models\User;
|
||||
use Illuminate\Support\Facades\Config;
|
||||
|
||||
uses(Illuminate\Foundation\Testing\RefreshDatabase::class);
|
||||
|
||||
test('auth pages show pixel logo SVG when pixel_logo_enabled is true', function (): void {
|
||||
Config::set('app.pixel_logo_enabled', true);
|
||||
|
||||
$response = $this->get('/login');
|
||||
|
||||
$response->assertStatus(200);
|
||||
$response->assertSee('viewBox="0 0 1000 150"', false);
|
||||
});
|
||||
|
||||
test('auth pages show heading instead of pixel logo when pixel_logo_enabled is false', function (): void {
|
||||
Config::set('app.pixel_logo_enabled', false);
|
||||
|
||||
$response = $this->get('/login');
|
||||
|
||||
$response->assertStatus(200);
|
||||
$response->assertDontSee('viewBox="0 0 1000 150"', false);
|
||||
$response->assertSee('LaraPaper');
|
||||
});
|
||||
|
||||
test('app logo shows text when pixel_logo_enabled is false', function (): void {
|
||||
Config::set('app.pixel_logo_enabled', false);
|
||||
|
||||
$user = User::factory()->create();
|
||||
$response = $this->actingAs($user)->get(route('dashboard'));
|
||||
|
||||
$response->assertStatus(200);
|
||||
$response->assertSee('LaraPaper');
|
||||
$response->assertDontSee('viewBox="0 0 1000 150"', false);
|
||||
});
|
||||
|
||||
test('app logo shows pixel logo SVG when pixel_logo_enabled is true', function (): void {
|
||||
Config::set('app.pixel_logo_enabled', true);
|
||||
|
||||
$user = User::factory()->create();
|
||||
$response = $this->actingAs($user)->get(route('dashboard'));
|
||||
|
||||
$response->assertStatus(200);
|
||||
$response->assertSee('viewBox="0 0 1000 150"', false);
|
||||
});
|
||||
|
|
@ -176,37 +176,15 @@ it('cleanup_folder identifies active images correctly', function (): void {
|
|||
expect($activeImageUuids)->not->toContain(null);
|
||||
});
|
||||
|
||||
it('reset_if_not_cacheable detects device models', function (): void {
|
||||
// Create a plugin
|
||||
$plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
|
||||
it('reset_if_not_cacheable does not reset recipe cache when other devices exist', function (): void {
|
||||
// Cache validity is now determined at use-time via metadata
|
||||
$plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid', 'plugin_type' => 'recipe']);
|
||||
Device::factory()->create(['device_model_id' => DeviceModel::factory()->create()->id]);
|
||||
|
||||
// Create a device with DeviceModel
|
||||
Device::factory()->create([
|
||||
'device_model_id' => DeviceModel::factory()->create()->id,
|
||||
]);
|
||||
|
||||
// Test that the method detects DeviceModels and resets cache
|
||||
ImageGenerationService::resetIfNotCacheable($plugin);
|
||||
|
||||
$plugin->refresh();
|
||||
expect($plugin->current_image)->toBeNull();
|
||||
});
|
||||
|
||||
it('reset_if_not_cacheable detects custom dimensions', function (): void {
|
||||
// Create a plugin
|
||||
$plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
|
||||
|
||||
// Create a device with custom dimensions
|
||||
Device::factory()->create([
|
||||
'width' => 1024, // Different from default 800
|
||||
'height' => 768, // Different from default 480
|
||||
]);
|
||||
|
||||
// Test that the method detects custom dimensions and resets cache
|
||||
ImageGenerationService::resetIfNotCacheable($plugin);
|
||||
|
||||
$plugin->refresh();
|
||||
expect($plugin->current_image)->toBeNull();
|
||||
expect($plugin->current_image)->toBe('test-uuid');
|
||||
});
|
||||
|
||||
it('reset_if_not_cacheable preserves cache for standard devices', function (): void {
|
||||
|
|
@ -258,26 +236,21 @@ it('reset_if_not_cacheable preserves cache for og_png and og_plus device models'
|
|||
expect($plugin->current_image)->toBe('test-uuid');
|
||||
});
|
||||
|
||||
it('reset_if_not_cacheable resets cache for non-standard device models', function (): void {
|
||||
// Create a plugin
|
||||
$plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
|
||||
|
||||
// Create a non-standard device model (e.g., kindle)
|
||||
it('reset_if_not_cacheable does not reset cache for non-standard device models', function (): void {
|
||||
// Cache is now validated at use-time via metadata comparison
|
||||
$plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid', 'plugin_type' => 'recipe']);
|
||||
$kindleModel = DeviceModel::factory()->create([
|
||||
'name' => 'test_amazon_kindle_2024',
|
||||
'width' => 1400,
|
||||
'height' => 840,
|
||||
'rotation' => 90,
|
||||
]);
|
||||
|
||||
// Create a device with the non-standard device model
|
||||
Device::factory()->create(['device_model_id' => $kindleModel->id]);
|
||||
|
||||
// Test that the method resets cache for non-standard device models
|
||||
ImageGenerationService::resetIfNotCacheable($plugin);
|
||||
|
||||
$plugin->refresh();
|
||||
expect($plugin->current_image)->toBeNull();
|
||||
expect($plugin->current_image)->toBe('test-uuid');
|
||||
});
|
||||
|
||||
it('reset_if_not_cacheable handles null plugin', function (): void {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue