mirror of
https://github.com/usetrmnl/byos_laravel.git
synced 2026-01-14 07:27:47 +00:00
feat: add header support for plugin data polling
This commit is contained in:
parent
a45684d940
commit
282fdac583
3 changed files with 72 additions and 34 deletions
61
README.md
61
README.md
|
|
@ -2,8 +2,8 @@
|
||||||
|
|
||||||
[](https://github.com/usetrmnl/byos_laravel/actions/workflows/test.yml)
|
[](https://github.com/usetrmnl/byos_laravel/actions/workflows/test.yml)
|
||||||
|
|
||||||
TRMNL BYOS Laravel is a self-hostable implementation of a TRMNL server, built with Laravel.
|
TRMNL BYOS Laravel is a self-hostable implementation of a TRMNL server, built with Laravel.
|
||||||
It enables you to manage TRMNL devices, generate screens dynamically, and can act as a proxy for the native cloud service (native plugins, receipts).
|
It enables you to manage TRMNL devices, generate screens dynamically, and can act as a proxy for the native cloud service (native plugins, receipts).
|
||||||
Inspired by [usetrmnl/byos_sinatra](https://github.com/usetrmnl/byos_sinatra).
|
Inspired by [usetrmnl/byos_sinatra](https://github.com/usetrmnl/byos_sinatra).
|
||||||
|
|
||||||
If you are looking for a Laravel package designed to streamline the development of both public and private TRMNL plugins, check out [bnussbau/trmnl-laravel](https://github.com/bnussbau/laravel-trmnl).
|
If you are looking for a Laravel package designed to streamline the development of both public and private TRMNL plugins, check out [bnussbau/trmnl-laravel](https://github.com/bnussbau/laravel-trmnl).
|
||||||
|
|
@ -15,11 +15,11 @@ If you are looking for a Laravel package designed to streamline the development
|
||||||
|
|
||||||
### Key Features
|
### Key Features
|
||||||
|
|
||||||
* 📡 Device Information – Display battery status, WiFi strength, firmware version, and more.
|
* 📡 Device Information – Display battery status, WiFi strength, firmware version, and more.
|
||||||
* 🔍 Auto-Join – Automatically detects and adds devices from your local network.
|
* 🔍 Auto-Join – Automatically detects and adds devices from your local network.
|
||||||
* 🖥️ Screen Generation – Supports Plugins, API, Markup or updates via Code.
|
* 🖥️ Screen Generation – Supports Plugins, API, Markup or updates via Code.
|
||||||
* 🔄 TRMNL API Proxy – Can act as a proxy for the native cloud service (requires TRMNL Developer Edition).
|
* 🔄 TRMNL API Proxy – Can act as a proxy for the native cloud service (requires TRMNL Developer Edition).
|
||||||
* This enables a hybrid setup – for example, you can update your custom Train Monitor every 5 minutes in the morning, while displaying native TRMNL plugins throughout the day.
|
* This enables a hybrid setup – for example, you can update your custom Train Monitor every 5 minutes in the morning, while displaying native TRMNL plugins throughout the day.
|
||||||
* 🌙 Dark Mode – Switch between light and dark mode.
|
* 🌙 Dark Mode – Switch between light and dark mode.
|
||||||
* 🐳 Deployment – Dockerized setup for easier hosting (Dockerfile, docker-compose).
|
* 🐳 Deployment – Dockerized setup for easier hosting (Dockerfile, docker-compose).
|
||||||
* 🛠️ Devcontainer support for easier development.
|
* 🛠️ Devcontainer support for easier development.
|
||||||
|
|
@ -114,6 +114,20 @@ Server is ready. Visit tab "Ports" in VSCode and visit the "Forwarded Address" i
|
||||||
|
|
||||||
Login with user / password `admin@example.com` / `admin@example.com`
|
Login with user / password `admin@example.com` / `admin@example.com`
|
||||||
|
|
||||||
|
### Demo Plugins
|
||||||
|
|
||||||
|
Run the ExampleReceiptsSeeder to seed the database with example plugins:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan db:seed --class=ExampleReceiptsSeeder
|
||||||
|
```
|
||||||
|
|
||||||
|
* Zen Quotes
|
||||||
|
* This Day in History
|
||||||
|
* Weather
|
||||||
|
* Train Departure Monitor
|
||||||
|
* Home Assistant
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
#### Environment Variables
|
#### Environment Variables
|
||||||
|
|
@ -143,11 +157,11 @@ If your environment is local, you can access the server at `http://localhost:456
|
||||||
##### Manually
|
##### Manually
|
||||||
|
|
||||||
1. Open the Devices page:
|
1. Open the Devices page:
|
||||||
👉 http://localhost:4567/devices
|
👉 http://localhost:4567/devices
|
||||||
2. Click “Add New Device”.
|
2. Click “Add New Device”.
|
||||||
3. Retrieve your TRMNL MAC Address and API Key:
|
3. Retrieve your TRMNL MAC Address and API Key:
|
||||||
- You can grab the TRMNL Mac Address and API Key from the TRMNL Dashboard
|
- You can grab the TRMNL Mac Address and API Key from the TRMNL Dashboard
|
||||||
- Alternatively, debug incoming requests to /api/setup to determine them
|
- Alternatively, debug incoming requests to /api/setup to determine them
|
||||||
|
|
||||||
### ⚙️ Configure Server for Device
|
### ⚙️ Configure Server for Device
|
||||||
|
|
||||||
|
|
@ -175,7 +189,7 @@ See this YouTube guide: [https://www.youtube.com/watch?v=3xehPW-PCOM](https://ww
|
||||||
|
|
||||||
#### 🎨 Blade View
|
#### 🎨 Blade View
|
||||||
* Edit `resources/views/trmnl.blade.php`
|
* Edit `resources/views/trmnl.blade.php`
|
||||||
* Available Blade Components are listed here: [laravel-trmnl | Blade Components](https://github.com/bnussbau/laravel-trmnl/tree/main/resources/views/components)
|
* Available Blade Components are listed here: [laravel-trmnl | Blade Components](https://github.com/bnussbau/laravel-trmnl/tree/main/resources/views/components)
|
||||||
* To generate the screen, run
|
* To generate the screen, run
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -252,42 +266,31 @@ Here are some features and improvements that are open for contribution:
|
||||||
|
|
||||||
##### 🔌 Plugin System
|
##### 🔌 Plugin System
|
||||||
|
|
||||||
- ~~Enable configurable plugins via the Web Interface.~~ ✅
|
|
||||||
- Ensure compatibility with the trmnl-laravel package.
|
- Ensure compatibility with the trmnl-laravel package.
|
||||||
- Implement auto-discovery for plugins.
|
- Implement auto-discovery for plugins.
|
||||||
|
|
||||||
##### ⏳ Scheduling / Playlists
|
|
||||||
|
|
||||||
- Move task scheduling from console.php to a Web Interface.
|
|
||||||
- ~~Allow users to configure custom schedule intervals.~~ ✅
|
|
||||||
|
|
||||||
##### 🖥️ “Native” Plugins
|
##### 🖥️ “Native” Plugins
|
||||||
- Add built-in plugins such as (as an example):
|
|
||||||
- ☁️ Weather
|
|
||||||
- 💬 Quotes
|
|
||||||
- 🏡 Home Assistant integration
|
|
||||||
- Provide Web UI controls to enable/disable plugins.
|
|
||||||
|
|
||||||
##### 📦 Visual Studio Code Devcontainer
|
- Architecture for native plugins.
|
||||||
* ~~Add a .devcontainer to this repo for easier development with Docker.~~ ✅
|
- Configuration UI
|
||||||
|
|
||||||
##### Improve Code Coverage
|
##### Improve Code Coverage
|
||||||
|
|
||||||
- Expand Pest tests to cover more functionality.
|
- Expand Pest tests to cover more functionality.
|
||||||
- Increase code coverage (currently at 86.9%).
|
- Increase code coverage
|
||||||
|
|
||||||
### 🤝 Contribution
|
### 🤝 Contribution
|
||||||
Contributions are welcome! If you’d like to improve the project, follow these steps:
|
Contributions are welcome! If you’d like to improve the project, follow these steps:
|
||||||
|
|
||||||
1. Open an Issue
|
1. Open an Issue
|
||||||
- Before submitting a pull request, create an issue to discuss your idea.
|
- Before submitting a pull request, create an issue to discuss your idea.
|
||||||
- Clearly describe the feature or bug fix you want to work on.
|
- Clearly describe the feature or bug fix you want to work on.
|
||||||
2. Fork the Repository & Create a Branch
|
2. Fork the Repository & Create a Branch
|
||||||
3. Make Your Changes & Add Tests
|
3. Make Your Changes & Add Tests
|
||||||
- Ensure your code follows best practices.
|
- Ensure your code follows best practices.
|
||||||
- Add Pest tests to cover your changes.
|
- Add Pest tests to cover your changes.
|
||||||
4. Run Tests
|
4. Run Tests
|
||||||
- `php artisan test`
|
- `php artisan test`
|
||||||
5. Submit a Pull Request (PR)
|
5. Submit a Pull Request (PR)
|
||||||
- Push your branch and create a PR.
|
- Push your branch and create a PR.
|
||||||
- Provide a clear description of your changes.
|
- Provide a clear description of your changes.
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,20 @@ class Plugin extends Model
|
||||||
public function updateDataPayload(): void
|
public function updateDataPayload(): void
|
||||||
{
|
{
|
||||||
if ($this->data_strategy === 'polling' && $this->polling_url) {
|
if ($this->data_strategy === 'polling' && $this->polling_url) {
|
||||||
$response = Http::withHeaders(['User-Agent' => 'usetrmnl/byos_laravel', 'Accept' => 'application/json'])
|
// Parse headers from polling_header string
|
||||||
|
$headers = ['User-Agent' => 'usetrmnl/byos_laravel', 'Accept' => 'application/json'];
|
||||||
|
|
||||||
|
if ($this->polling_header) {
|
||||||
|
$headerLines = explode("\n", trim($this->polling_header));
|
||||||
|
foreach ($headerLines as $line) {
|
||||||
|
$parts = explode(':', $line, 2);
|
||||||
|
if (count($parts) === 2) {
|
||||||
|
$headers[trim($parts[0])] = trim($parts[1]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$response = Http::withHeaders($headers)
|
||||||
->get($this->polling_url)
|
->get($this->polling_url)
|
||||||
->json();
|
->json();
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -83,9 +83,24 @@ new class extends Component {
|
||||||
public function updateData()
|
public function updateData()
|
||||||
{
|
{
|
||||||
if ($this->plugin->data_strategy === 'polling') {
|
if ($this->plugin->data_strategy === 'polling') {
|
||||||
$response = Http::get($this->plugin->polling_url)->json();
|
// Parse headers from polling_header string
|
||||||
$this->plugin->update(['data_payload' => $response]);
|
$headers = ['User-Agent' => 'usetrmnl/byos_laravel', 'Accept' => 'application/json'];
|
||||||
|
|
||||||
|
if ($this->plugin->polling_header) {
|
||||||
|
$headerLines = explode("\n", trim($this->plugin->polling_header));
|
||||||
|
foreach ($headerLines as $line) {
|
||||||
|
$parts = explode(':', $line, 2);
|
||||||
|
if (count($parts) === 2) {
|
||||||
|
$headers[trim($parts[0])] = trim($parts[1]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$response = Http::withHeaders($headers)
|
||||||
|
->get($this->plugin->polling_url)
|
||||||
|
->json();
|
||||||
|
|
||||||
|
$this->plugin->update(['data_payload' => $response]);
|
||||||
$this->data_payload = json_encode($response);
|
$this->data_payload = json_encode($response);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -289,8 +304,15 @@ HTML;
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="mb-4">
|
<div class="mb-4">
|
||||||
<flux:input label="Polling Header" wire:model="polling_header" id="polling_header"
|
<flux:textarea
|
||||||
class="block mt-1 w-full" type="text" name="polling_header" autofocus/>
|
label="Polling Headers (one per line, format: Header: Value)"
|
||||||
|
wire:model="polling_header"
|
||||||
|
id="polling_header"
|
||||||
|
class="block mt-1 w-full font-mono"
|
||||||
|
name="polling_header"
|
||||||
|
rows="3"
|
||||||
|
placeholder="Authorization: Bearer ey.******* Content-Type: application/json"
|
||||||
|
/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="flex">
|
<div class="flex">
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue