xibel/laravel-dashboard-youless-tile

A tile for Laravel-Dashboard that displays statistics from a Youless LS120 energy reader

2.1 2023-07-31 18:44 UTC

Requires

• php: ^8.0
• spatie/laravel-dashboard: ^2.0

Requires (Dev)

• phpunit/phpunit: ^9.3@dev

MIT

• Xibel

• php
• laravel
• laravel-dashboard
• laravel-dashboard-tile
• xibel
• laravel-dashboard-youless-tile
• youless
• LS120

README

A tile for Laravel Dashboard that displays statistics from a Youless LS120 Energy Monitor. This tile can be used on the Laravel Dashboard from Spatie.

Impression

For more information about this package see my website Xibel-IT.

Install

Via Composer

$ composer require xibel/laravel-dashboard-youless-tile

Configuration

In the \config\dashboard.php config file, you must add this configuration in the tiles key:

return [
    // ...
    'tiles' => [
        'youless' => [
            'url' => env('YOULESS_URL'),
            'refresh_interval_in_seconds' => 10,
        ],
    ],
];

In app\Console\Kernel.php you should schedule the xibel\YoulessTile\Commands\FetchDataFromYoulessCommand to run every 1 minute.

protected function schedule(Schedule $schedule)
{
    // Youless tile
        $schedule->command(\xibel\YoulessTile\Commands\FetchDataFromYoulessCommand::class)->everyMinute();

}

To fetch data from your Youless at lease once, run 'php artisan schedule:run'. Use a tool like supervisor to keep the scheduler running.

In the .env file, you must add the 'YOULESS_URL' key and provide your Youless IP address or hostname:

YOULESS_URL=x.x.x.x

In your dashboard view you use the livewire:youless-summary-tile component.

<x-dashboard>
    <livewire:youless-tile position="a1" />
</x-dashboard>

Change log

Please see CHANGELOG for more version information.

Credits

• Xibel
• All Contributors

License

The MIT License (MIT). Please see License File for more information.