initial commit

README.md

@@ -1,66 +1,70 @@
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
+## Laravel Trmnl Server
 
-<p align="center">
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
-</p>
+This is a PoC of a TRMNL server, written in Laravel. Inspired by https://github.com/usetrmnl/byos_sinatra
 
-## About Laravel
+⚠️ Not meant for production use.️️ ⚠️
 
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
+### Installation
 
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
-- [Powerful dependency injection container](https://laravel.com/docs/container).
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
-- [Robust background job processing](https://laravel.com/docs/queues).
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+#### Clone the repository
 
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+```bash
+git clone git@github.com:bnussbau/laravel-trmnl-server.git
+```
 
-## Learning Laravel
+#### Copy environment file
 
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
+```bash
+cp .env.example .env
+php artisan key:generate
+```
 
-You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
+#### Install dependencies
 
-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
+```bash
+composer install
+npm i
+```
 
-## Laravel Sponsors
+#### Run migrations
 
-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
+```bash
+php artisan migrate --seed
+```
 
-### Premium Partners
+#### Run the server
 
-- **[Vehikl](https://vehikl.com/)**
-- **[Tighten Co.](https://tighten.co)**
-- **[WebReinvent](https://webreinvent.com/)**
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
-- **[64 Robots](https://64robots.com)**
-- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
-- **[Cyber-Duck](https://cyber-duck.co.uk)**
-- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
-- **[Jump24](https://jump24.co.uk)**
-- **[Redberry](https://redberry.international/laravel/)**
-- **[Active Logic](https://activelogic.com)**
-- **[byte5](https://byte5.de)**
-- **[OP.GG](https://op.gg)**
+To make your server accessible in the network, you can run the following command:
 
-## Contributing
+```bash
+php artisan serve  --host=0.0.0.0 --port 4567
+```
 
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+### Usage
 
-## Code of Conduct
+If your environment is local, you can access the server at `http://localhost:4567` and login with user / password
+admin@example.com / admin@example.com
 
-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+#### Add your TRMNL Device
 
-## Security Vulnerabilities
+http://localhost:4567/devices
 
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
+* Add new device
+* You can grab the TRMNL Mac Address and API Key from the TRMNL Dashboard. Or debug the incoming request to `/api/setup` to determine.
 
-## License
+#### Flash Firmware to point Device to your server
+See this YouTube guide: [https://www.youtube.com/watch?v=3xehPW-PCOM](https://www.youtube.com/watch?v=3xehPW-PCOM)
+
+#### Generate Screen
+
+* Edit resources/views/trmnl.blade.php
+* To generate the screen, run
+
+```bash
+php artisan trmnl:screen:generate
+```
+
+
+### License
+MIT
 
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

app/Console/Commands/ScreenGeneratorCommand.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Models\Device;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Storage;
+use Ramsey\Uuid\Uuid;
+use Spatie\Browsershot\Browsershot;
+
+class ScreenGeneratorCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'trmnl:screen:generate {deviceId=1}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = '';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle()
+    {
+
+        $deviceId = $this->argument('deviceId');
+
+        $uuid = Uuid::uuid4()->toString();
+        $pngPath = public_path('storage/images/generated/').$uuid.'.png';
+        $bmpPath = public_path('storage/images/generated/').$uuid.'.bmp';
+
+        // Generate PNG
+        try {
+            Browsershot::html(view('trmnl')->render())
+                ->windowSize(800, 480)
+                ->save($pngPath);
+        } catch (\Exception $e) {
+            $this->error('Failed to generate PNG: '.$e->getMessage());
+
+            return;
+        }
+
+        try {
+            $this->convertToBmpImageMagick($pngPath, $bmpPath);
+
+        } catch (\ImagickException $e) {
+            $this->error('Failed to convert image to BMP: '.$e->getMessage());
+        }
+
+        Device::find($deviceId)->update(['current_screen_image' => $uuid]);
+
+        $this->cleanupFolder();
+    }
+
+    /**
+     * @throws \ImagickException
+     */
+    public function convertToBmpImageMagick(string $pngPath, string $bmpPath): void
+    {
+        $imagick = new \Imagick($pngPath);
+        $imagick->setImageType(\Imagick::IMGTYPE_GRAYSCALE);
+        $imagick->quantizeImage(2, \Imagick::COLORSPACE_GRAY, 0, true, false);
+        $imagick->setImageDepth(1);
+        $imagick->stripImage();
+        $imagick->setFormat('BMP3');
+        $imagick->writeImage($bmpPath);
+        $imagick->clear();
+    }
+
+    // TODO retuns 8-bit BMP
+
+    //    public function convertToBmpGD(string $pngPath, string $bmpPath): void
+    //    {
+    //        // Load the PNG image
+    //        $image = imagecreatefrompng($pngPath);
+    //
+    //        // Create a new true color image with the same dimensions
+    //        $bwImage = imagecreatetruecolor(imagesx($image), imagesy($image));
+    //
+    //        // Convert to black and white
+    //        imagefilter($image, IMG_FILTER_GRAYSCALE);
+    //
+    //        // Copy the grayscale image to the new image
+    //        imagecopy($bwImage, $image, 0, 0, 0, 0, imagesx($image), imagesy($image));
+    //
+    //        // Create a 1-bit palette
+    //        imagetruecolortopalette($bwImage, true, 2);
+    //
+    //        // Save as BMP
+    //
+    //        imagebmp($bwImage, $bmpPath, false);
+    //
+    //        // Free up memory
+    //        imagedestroy($image);
+    //        imagedestroy($bwImage);
+    //    }
+    public function cleanupFolder(): void
+    {
+        $activeImageUuids = Device::pluck('current_screen_image')->filter()->toArray();
+
+        $files = Storage::disk('public')->files('/images/generated/');
+        foreach ($files as $file) {
+            if (basename($file) === '.gitignore') {
+                continue;
+            }
+            // Get filename without path and extension
+            $fileUuid = pathinfo($file, PATHINFO_FILENAME);
+            // If the UUID is not in use by any device, move it to archive
+            if (! in_array($fileUuid, $activeImageUuids)) {
+                Storage::disk('public')->delete($file);
+            }
+        }
+    }
+}

app/Livewire/DeviceManager.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace App\Livewire;
+
+use App\Models\Device;
+use Livewire\Component;
+use Livewire\WithPagination;
+
+class DeviceManager extends Component
+{
+    use WithPagination;
+
+    public $showDeviceForm = false;
+
+    public $name;
+
+    public $mac_address;
+
+    public $api_key;
+
+    public $default_refresh_interval = 900;
+
+    public $friendly_id;
+
+    protected $rules = [
+        'mac_address' => 'required',
+        'api_key' => 'required',
+        'default_refresh_interval' => 'required|integer',
+    ];
+
+    public function render()
+    {
+        return view('livewire.device-manager', [
+            'devices' => auth()->user()->devices()->paginate(10),
+        ]);
+    }
+
+    public function createDevice(): void
+    {
+        $this->validate();
+
+        Device::factory([
+            'name' => $this->name,
+            'mac_address' => $this->mac_address,
+            'api_key' => $this->api_key,
+            'default_refresh_interval' => $this->default_refresh_interval,
+            'friendly_id' => $this->friendly_id,
+            'user_id' => auth()->id(),
+        ])->create();
+
+        $this->reset();
+        session()->flash('message', 'Device created successfully.');
+    }
+
+    public function toggleDeviceForm()
+    {
+        $this->showDeviceForm = ! $this->showDeviceForm;
+    }
+}

app/Models/Device.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+class Device extends Model
+{
+    use HasFactory;
+
+    protected $guarded = ['id'];
+}

app/Models/User.php

@@ -4,13 +4,15 @@ namespace App\Models;
 
 // use Illuminate\Contracts\Auth\MustVerifyEmail;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
+use Laravel\Sanctum\HasApiTokens;
 
 class User extends Authenticatable
 {
     /** @use HasFactory<\Database\Factories\UserFactory> */
-    use HasFactory, Notifiable;
+    use HasApiTokens, HasFactory, Notifiable;
 
     /**
      * The attributes that are mass assignable.
@@ -45,4 +47,9 @@ class User extends Authenticatable
             'password' => 'hashed',
         ];
     }
+
+    public function devices(): HasMany
+    {
+        return $this->hasMany(Device::class);
+    }
 }

app/Utils/OneBitModifier.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Utils;
+
+use Intervention\Image\Interfaces\ImageInterface;
+use Intervention\Image\Interfaces\ModifierInterface;
+
+class OneBitModifier implements ModifierInterface
+{
+    public function apply(ImageInterface $image): ImageInterface
+    {
+        foreach ($image as $pixel) {
+            // Get brightness value of pixel (0-255)
+            $brightness = $pixel->brightness();
+
+            // Convert to Black or White based on a threshold (128)
+            if ($brightness < 128) {
+                $pixel->set([0, 0, 0]); // Black
+            } else {
+                $pixel->set([255, 255, 255]); // White
+            }
+        }
+
+        return $image;
+    }
+}

bootstrap/app.php

@@ -7,6 +7,7 @@ use Illuminate\Foundation\Configuration\Middleware;
 return Application::configure(basePath: dirname(__DIR__))
     ->withRouting(
         web: __DIR__.'/../routes/web.php',
+        api: __DIR__.'/../routes/api.php',
         commands: __DIR__.'/../routes/console.php',
         health: '/up',
     )

composer.json

@@ -7,10 +7,15 @@
     "license": "MIT",
     "require": {
         "php": "^8.2",
+        "ext-imagick": "*",
+        "bnussbau/laravel-trmnl": "^0.1.0",
+        "intervention/image": "^3.11",
         "laravel/framework": "^11.31",
+        "laravel/sanctum": "^4.0",
         "laravel/tinker": "^2.9",
         "livewire/livewire": "^3.4",
-        "livewire/volt": "^1.0"
+        "livewire/volt": "^1.0",
+        "spatie/browsershot": "^5.0"
     },
     "require-dev": {
         "fakerphp/faker": "^1.23",
@@ -21,7 +26,8 @@
         "mockery/mockery": "^1.6",
         "nunomaduro/collision": "^8.1",
         "pestphp/pest": "^3.7",
-        "pestphp/pest-plugin-laravel": "^3.1"
+        "pestphp/pest-plugin-laravel": "^3.1",
+        "spatie/ray": "^1.41"
     },
     "autoload": {
         "psr-4": {

config/sanctum.php

@@ -0,0 +1,83 @@
+<?php
+
+use Laravel\Sanctum\Sanctum;
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Stateful Domains
+    |--------------------------------------------------------------------------
+    |
+    | Requests from the following domains / hosts will receive stateful API
+    | authentication cookies. Typically, these should include your local
+    | and production domains which access your API via a frontend SPA.
+    |
+    */
+
+    'stateful' => explode(',', env('SANCTUM_STATEFUL_DOMAINS', sprintf(
+        '%s%s',
+        'localhost,localhost:3000,127.0.0.1,127.0.0.1:8000,::1',
+        Sanctum::currentApplicationUrlWithPort()
+    ))),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Sanctum Guards
+    |--------------------------------------------------------------------------
+    |
+    | This array contains the authentication guards that will be checked when
+    | Sanctum is trying to authenticate a request. If none of these guards
+    | are able to authenticate the request, Sanctum will use the bearer
+    | token that's present on an incoming request for authentication.
+    |
+    */
+
+    'guard' => ['web'],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Expiration Minutes
+    |--------------------------------------------------------------------------
+    |
+    | This value controls the number of minutes until an issued token will be
+    | considered expired. This will override any values set in the token's
+    | "expires_at" attribute, but first-party sessions are not affected.
+    |
+    */
+
+    'expiration' => null,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Token Prefix
+    |--------------------------------------------------------------------------
+    |
+    | Sanctum can prefix new tokens in order to take advantage of numerous
+    | security scanning initiatives maintained by open source platforms
+    | that notify developers if they commit tokens into repositories.
+    |
+    | See: https://docs.github.com/en/code-security/secret-scanning/about-secret-scanning
+    |
+    */
+
+    'token_prefix' => env('SANCTUM_TOKEN_PREFIX', ''),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Sanctum Middleware
+    |--------------------------------------------------------------------------
+    |
+    | When authenticating your first-party SPA with Sanctum you may need to
+    | customize some of the middleware Sanctum uses while processing the
+    | request. You may change the middleware listed below as required.
+    |
+    */
+
+    'middleware' => [
+        'authenticate_session' => Laravel\Sanctum\Http\Middleware\AuthenticateSession::class,
+        'encrypt_cookies' => Illuminate\Cookie\Middleware\EncryptCookies::class,
+        'validate_csrf_token' => Illuminate\Foundation\Http\Middleware\ValidateCsrfToken::class,
+    ],
+
+];

database/factories/DeviceFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Database\Factories;
+
+use App\Models\Device;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Str;
+
+class DeviceFactory extends Factory
+{
+    protected $model = Device::class;
+
+    public function definition(): array
+    {
+        return [
+            'name' => $this->faker->firstName().' TRMNL',
+            'mac_address' => $this->faker->macAddress(),
+            'default_refresh_interval' => '900',
+            'friendly_id' => Str::random(6),
+            'api_key' => 'tD-'.Str::random(19),
+            'user_id' => 1,
+            'created_at' => Carbon::now(),
+            'updated_at' => Carbon::now(),
+        ];
+    }
+}

database/migrations/2025_02_08_141911_create_personal_access_tokens_table.php

@@ -0,0 +1,33 @@
+<?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::create('personal_access_tokens', function (Blueprint $table) {
+            $table->id();
+            $table->morphs('tokenable');
+            $table->string('name');
+            $table->string('token', 64)->unique();
+            $table->text('abilities')->nullable();
+            $table->timestamp('last_used_at')->nullable();
+            $table->timestamp('expires_at')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('personal_access_tokens');
+    }
+};

database/migrations/2025_02_08_143219_create_devices_table.php

@@ -0,0 +1,31 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('devices', function (Blueprint $table) {
+            $table->id();
+            $table->string('name')->nullable();
+            $table->string('mac_address');
+            $table->integer('default_refresh_interval')->default(900);
+            $table->string('friendly_id')->nullable();
+            $table->string('api_key')->nullable();
+            $table->integer('last_rssi_level')->nullable();
+            $table->double('last_battery_voltage')->nullable();
+            $table->string('last_firmware_version')->nullable();
+            $table->string('current_screen_image')->nullable();
+            $table->unsignedBigInteger('user_id')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('devices');
+    }
+};

package.json

@@ -14,5 +14,8 @@
         "postcss": "^8.4.31",
         "tailwindcss": "^3.1.0",
         "vite": "^6.0.11"
+    },
+    "dependencies": {
+        "puppeteer": "^24.2.0"
     }
 }

resources/views/components/nav-link.blade.php

@@ -2,7 +2,7 @@
 
 @php
 $classes = ($active ?? false)
-            ? 'inline-flex items-center px-1 pt-1 border-b-2 border-indigo-400 dark:border-indigo-600 text-sm font-medium leading-5 text-gray-900 dark:text-gray-100 focus:outline-none focus:border-indigo-700 transition duration-150 ease-in-out'
+            ? 'inline-flex items-center px-1 pt-1 border-b-2 border-orange-400 dark:border-orange-600 text-sm font-medium leading-5 text-gray-900 dark:text-gray-100 focus:outline-none focus:border-orange-700 transition duration-150 ease-in-out'
             : 'inline-flex items-center px-1 pt-1 border-b-2 border-transparent text-sm font-medium leading-5 text-gray-500 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-300 hover:border-gray-300 dark:hover:border-gray-700 focus:outline-none focus:text-gray-700 dark:focus:text-gray-300 focus:border-gray-300 dark:focus:border-gray-700 transition duration-150 ease-in-out';
 @endphp
 

resources/views/components/primary-button.blade.php

@@ -1,3 +1,3 @@
-<button {{ $attributes->merge(['type' => 'submit', 'class' => 'inline-flex items-center px-4 py-2 bg-gray-800 dark:bg-gray-200 border border-transparent rounded-md font-semibold text-xs text-white dark:text-gray-800 uppercase tracking-widest hover:bg-gray-700 dark:hover:bg-white focus:bg-gray-700 dark:focus:bg-white active:bg-gray-900 dark:active:bg-gray-300 focus:outline-none focus:ring-2 focus:ring-indigo-500 focus:ring-offset-2 dark:focus:ring-offset-gray-800 transition ease-in-out duration-150']) }}>
+<button {{ $attributes->merge(['type' => 'submit', 'class' => 'inline-flex items-center px-4 py-2 bg-gray-800 dark:bg-gray-200 border border-transparent rounded-md font-semibold text-xs text-white dark:text-gray-800 uppercase tracking-widest hover:bg-gray-700 dark:hover:bg-white focus:bg-gray-700 dark:focus:bg-white active:bg-gray-900 dark:active:bg-gray-300 focus:outline-none focus:ring-2 focus:ring-orange-500 focus:ring-offset-2 dark:focus:ring-offset-gray-800 transition ease-in-out duration-150']) }}>
     {{ $slot }}
 </button>

resources/views/components/responsive-nav-link.blade.php

@@ -2,7 +2,7 @@
 
 @php
 $classes = ($active ?? false)
-            ? 'block w-full ps-3 pe-4 py-2 border-l-4 border-indigo-400 dark:border-indigo-600 text-start text-base font-medium text-indigo-700 dark:text-indigo-300 bg-indigo-50 dark:bg-indigo-900/50 focus:outline-none focus:text-indigo-800 dark:focus:text-indigo-200 focus:bg-indigo-100 dark:focus:bg-indigo-900 focus:border-indigo-700 dark:focus:border-indigo-300 transition duration-150 ease-in-out'
+            ? 'block w-full ps-3 pe-4 py-2 border-l-4 border-orange-400 dark:border-orange-600 text-start text-base font-medium text-orange-700 dark:text-orange-300 bg-orange-50 dark:bg-orange-900/50 focus:outline-none focus:text-orange-800 dark:focus:text-orange-200 focus:bg-orange-100 dark:focus:bg-orange-900 focus:border-orange-700 dark:focus:border-orange-300 transition duration-150 ease-in-out'
             : 'block w-full ps-3 pe-4 py-2 border-l-4 border-transparent text-start text-base font-medium text-gray-600 dark:text-gray-400 hover:text-gray-800 dark:hover:text-gray-200 hover:bg-gray-50 dark:hover:bg-gray-700 hover:border-gray-300 dark:hover:border-gray-600 focus:outline-none focus:text-gray-800 dark:focus:text-gray-200 focus:bg-gray-50 dark:focus:bg-gray-700 focus:border-gray-300 dark:focus:border-gray-600 transition duration-150 ease-in-out';
 @endphp