Initial

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**FPP information (please complete the following information):**
+ - Device [e.g. Beaglebone Black, Raspberry Pi]
+ - Version [e.g. 6.x]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: composer
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 5
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 5

.github/workflows/release.yml

@@ -0,0 +1,14 @@
+on:
+  release:
+      types: [published]
+
+jobs:
+  update_package:
+      runs-on: ubuntu-latest
+      steps:
+      -   name: Packagist Update
+          uses: mnavarrocarter/packagist-update@v1.0.0
+          with:
+              username: almostengr
+              api_token: ${{ secrets.PACKAGIST_TOKEN }}
+              package_name: almostengr/show-pulse-fpp

.github/workflows/run-php-unit-tests.yml.disabled

@@ -0,0 +1,40 @@
+name: Run PHPUnit Tests
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
+    # Docs: https://getcomposer.org/doc/articles/scripts.md
+
+    # - name: Run test suite
+    #   run: composer run-script test
+
+    - name: Run PHPUnit tests
+      run: vendor/bin/phpunit --colors=never

.gitignore

@@ -0,0 +1,4 @@
+.phpunit.cache
+
+/vendor/
+.swp

README.md

@@ -1,2 +1,44 @@
-# light-show-guard-plugin
-FPP Plugin for Light Show Guard
+# Show Pulse Plugin for Falcon Pi Player
+
+Show Pulse plugin allows you to see and remotely controller what happens with your light show. This
+plugin is designed to work with Falcon Pi Player.
+
+
+## Install Plugin
+
+There are two ways to install the plugin. Using FPP user interface or using PHP's Composer.
+
+### Using FPP
+
+To install the plugin to your Falcon Pi Player, go to the Plugins section of the FPP. Then copy and
+paste the URL below to install the plugin.
+
+```sh
+https://raw.githubusercontent.com/almostengr/show-pulse-fpp/main/pluginInfo.json
+```
+
+### Using Composer
+
+Open a terminal or command prompt window, and go to the plugin directory or other directory of your chosing. Then enter the command
+
+```sh
+composer require almostengr/show-pulse-fpp
+```
+
+## Setup
+
+See the [User Guide](https://lightshowpulse.com/pages/user-guide/fpp-plugin-quick-start) for how
+to configure the plugin.
+
+
+## Version Numbering
+
+The version number for this plugin is in the following format. Using the example of
+
+```txt
+5.2024.07.26
+```
+
+"5" represents the major Falcon Pi Player version number that the plugin is designed for
+
+"2024.07.26" represents the date, in YYYY-MM-DD format, that the release was created

ShowPulseDaemon.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App;
+
+use App\Commands\JukeboxSelectionInsertNextCommandHandler;
+use App\Commands\PostStatusToWebsiteCommandHandler;
+use App\Commands\ShowPulseConstant;
+use Exception;
+
+require_once "commands/InsertNextJukeboxSelectionCommandHandler.php";
+require_once "commands/PostStatusToWebsiteCommandHandler.php";
+
+$postStatusCommand = new PostStatusToWebsiteCommandHandler();
+$nextSelectionCommand = new JukeboxSelectionInsertNextCommandHandler();
+
+$failureCount = 0;
+$delaySeconds = 2;
+
+do {
+    try {
+        $postStatusCommand->execute();
+        $nextSelectionCommand->execute();
+
+        sleep(ShowPulseConstant::SLEEP_SHORT_VALUE);
+
+        $failureCount = 0;
+    } catch (Exception $e) {
+        if ($failureCount < ShowPulseConstant::MAX_FAILURES_ALLOWED) {
+            $message = $e->getMessage() . " (Attempt  $failureCount)";
+            $postStatusCommand->logError($message);
+            $failureCount++;
+        }
+
+        $sleepTime = $failureCount * $delaySeconds;
+        sleep($sleepTime);
+    }
+
+    $daemonFileExists = file_exists(ShowPulseConstant::DAEMON_FILE);
+} while ($daemonFileExists);
+
+$postStatusCommand->logError("Daemon stopped.");

about.php

@@ -0,0 +1,16 @@
+<div style="margin:0 auto;"> <br />
+    <fieldset style="padding: 10px; border: 2px solid #000;">
+        <legend>Show Pulse Plugin</legend>
+        <div style="overflow: hidden; padding: 10px;">
+            <div id='credits'>
+                <b>Show Pulse Plugin Developed By:</b><br />
+                <br />
+                Kenny Robinson (almostengr)<br />
+                <br />
+                <a href='https://github.com/almostengr/show-pulse-fpp'>Git Repository</a><br>
+                <a href='https://github.com/almostengr/show-pulse-fpp/issues'>Bug Reporter</a><br>
+                <br />
+            </div>
+        </div>
+    </fieldset>
+</div>

commands/BaseCommandHandler.php

@@ -0,0 +1,153 @@
+<?php
+
+namespace App\Commands;
+
+$commonFile = $testing ? __DIR__ . "/tests/OptFppWwwCommonMock.php" : "/opt/fpp/www/common.php";
+require_once $commonFile;
+
+interface ShowPulseCommandHandlerInterface
+{
+    protected function execute();
+}
+
+abstract class BaseCommandHandler
+{
+    private $token;
+    private $showUuid;
+    private $websiteApiUrl;
+
+    protected function fppHttpRequest($route, $method = "GET", $data = null)
+    {
+        $headers = array();
+
+        array_push($headers, "Authorization: Bearer $this->token");
+
+        $url = "https://127.0.0.1/api/";
+        return $this->httpRequest($url, $route, $method, $data);
+    }
+
+    protected function httpRequest($url, $route, $method = "GET", $data = null)
+    {
+        $headers = array();
+
+
+        array_push($headers, "Content-Type: application/json");
+        array_push($headers, "Accept: application/json");
+
+        $url = $url . $route;
+
+        $ch = curl_init($url);
+        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+
+        $method = strtoupper($method);
+        if ($method === "POST" || $method === "PUT") {
+            curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
+        }
+
+        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
+
+        $response = curl_exec($ch);
+
+        if ($response === false) {
+            return $this->logError("cURL error: " . curl_error($ch));
+        }
+
+        curl_close($ch);
+
+        if ($response === null) {
+            return $this->logError("Bad response returned.");
+        }
+
+        return json_decode($response, true);
+    }
+
+    protected function getShowUuid()
+    {
+        return $this->showUuid;
+    }
+
+    public function logError($message)
+    {
+        $currentDateTime = date('Y-m-d h:i:s A');
+        error_log("$currentDateTime: $message");
+        return false;
+    }
+
+    protected function isNullOrEmpty($value)
+    {
+        return is_null($value) || empty($value);
+    }
+
+    protected function isNotNullOrEmpty($value)
+    {
+        return !$this->isNullOrEmpty($value);
+    }
+
+    protected function loadConfiguration(): bool
+    {
+        $configFile = GetDirSetting("uploads") . "/showpulse.json";
+        $contents = file_get_contents($configFile);
+
+        if ($contents === false) {
+            return $this->logError("Configuration file not found or unable to be loaded. Download configuration file contents from the Light Show Pulse website. Then restart FPPD.");
+        }
+
+        $json = json_decode($contents, false);
+
+        $this->showUuid = $json->show_id;
+        $this->token = $json->token;
+        $this->websiteApiUrl = $json->host;
+        return true;
+    }
+
+    protected function getStatusFromFpp()
+    {
+        $fppStatus = $this->httpRequest(true, "fppd/status");
+
+        if ($this->isNullOrEmpty($fppStatus)) {
+            return $this->logError("Unable to get latest status from FPP.");
+        }
+
+        return $fppStatus;
+    }
+
+    protected function postStatusToWebsite($statusDto)
+    {
+        $response = $this->httpRequest(
+            false,
+            "show-statuses/add/" . $this->getShowUuid(),
+            "POST",
+            $statusDto
+        );
+
+        if ($response->failed) {
+            return $this->logError("Unable to update show status. " . $response->message);
+        }
+
+        return $response;
+    }
+}
+
+final class ShowPulseConstant
+{
+    public const FPP_STATUS_IDLE = 0;
+    public const GRACEFUL_RESTART = "GRACEFUL RESTART";
+    public const GRACEFUL_SHUTDOWN = "GRACEFUL SHUTDOWN";
+    public const GRACEFUL_STOP = "GRACEFUL STOP";
+    public const HIGH_PRIORITY = 10;
+    public const IMMEDIATE_RESTART = "IMMEDIATE RESTART";
+    public const IMMEDIATE_SHUTDOWN = "IMMEDIATE SHUTDOWN";
+    public const IMMEDIATE_STOP = "IMMEDIATE STOP";
+    public const MAX_FAILURES_ALLOWED = 5;
+    public const SLEEP_SHORT_VALUE = 5;
+    public const DAEMON_FILE = "/home/fpp/media/plugins/show-pulse-fpp/daemon.run";
+}
+
+final class ShowPulseApiResponseDto
+{
+    public $success;
+    public $failed;
+    public $message;
+    public $data;
+}