Prepare for Alpha.10 (#1272)

* Update Changelog for Alpha.10

* Address lgtm findings

* Correct some texts

* Improve Password handling

* search for turbojpeg only if MF is enabled

* Chnagelog updates

* Fix LED layout overwrite for previously save LEDs

* LED Device- Fix default selection for selected network devices

* Sreengrabber - Select default fps

* Update database migration steps

Co-authored-by: Markus <16664240+Paulchen-Panther@users.noreply.github.com>

Author: Lord-Grey

CHANGELOG.md

@@ -6,32 +6,118 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://github.com/hyperion-project/hyperion.ng/compare/2.0.0-alpha.9...HEAD)
 
+The focus of this release is on user experience.
+We tried as much as possible supporting you in getting valid setup done, as well as providing enough room for expert users to tweak configurations here and there.
+The reworked dashboard provides you now with the ability to control individual components, jump to key configuration items, as well as to switch between LED instances easily.
+The refined color coding in the user-interfaces, helps you to quickly identify instance specific and global configuration items.
+
+Of course, the release brings new features (e.g. USB Capture on Windows), as well as minor enhancements and a good number of fixes.
+
+Note: 
+
+- Hyperion packages can now be installed under Ubuntu (x64) and Debian (amd64/armhf) (incl. Raspberry Pi OS) via our own APT server. 
+Details about the installation can be found in the [installation.md](https://github.com/hyperion-project/hyperion.ng/blob/master/Installation.md) and at [apt.hyperion-project.org](apt.hyperion-project.org).
+- Find here more details on [supported platforms and configuration sets](https://github.com/hyperion-project/hyperion.ng/blob/master/doc/development/SupportedPlatforms.md)
+
 ### Breaking
 
 ### Added
-- LED-Devices: basic support for Hue Play Gradient Lightstrip
 
-- WLED: Support of ["live" property] (https://github.com/Aircoookie/WLED/issues/1308), addresses #1095
-- WLED: Support storing/restoring state, fixes #1101
-- LED-Devices: Allow to get properties for Atmo and Karatedevices to limit LED numbers configurable
-- LED-Devices: Add timeouts for REST-API calls
-- new Flags: Russia, Cameroon, Great Britain, England, Scotland
+- The Dashboard is now a one-stop control element to control instances and link into configuration areas
+- LED Instance independent configuration objects (e.g. capturing hardware) are now separated out in the menu
+- New menu item "Sources" per LED instances configuration to enable/disable screen or usb grabber per instance
+
+#### Grabbers
+- Windows Media Foundation USB grabber (incl. Media Foundation transform/Turbo-JPEG scaling)
+- Linux V4L2 Grabber now supports the following formats: NV12, YUV420
+- Image flipping ability in ImageResampler/Turbo-JPEG
+- UI: Simplified screens for non-expert usage, do only show elements relevant
+- Discover available Grabbers (incl. their capabilities for selection), not supported grabbers are not presented. Note: Screen capturing on Wayland is not supported (given the Wayland security architecture)
+- USB Grabber: New ability to configure hardware controls (brightness, contrast, saturation, hue), as well as populating defaults
+- Configuration item ranges are automatically adopted based on grabber capabilities,
+- Grabbers can only be saved with a valid configuration
+- Standalone grabbers: Added consistent options/capabilities for standalone grabbers, debug logging support
+- Screen grabbers: Allow to set capture frequency, size decimation and cropping across all grabber types
+- Screen grabber: QT-Grabber allows to capture individual displays or all displays in a multi-display setup
+- Display Signal Detection area in preview (expert users)
+- UI: Only show CEC detection, if supported by platform
+
+#### LED-Devices
+- Select device from list of available devices (UI Optimization - Select device from list of available devices #1053) - Cololight, Nanoleaf, Serial Devices (e.g. Adalight), SPI-Device, Pi-Blaster
+- Get device properties for automatic configuration of number of LEDs and initial layout (WLED, Cololight, Nanoleaf)
+- Identify/Test device (WLED, Cololight, Nanoleaf, Adalight)
+- For selected devices a default layout configuration is created, if the user chooses "Overwrite" (WLED, Cololight, Nanoleaf, all serial devices, all spi device, pi-blaster)
+- Ensure Hardware LED count matches number of lights (Philips Hue, Yeelight, Atmo Orb)
+- User is presented a warning/error, if there is a mismatch between configured LED number and available hardware LEDs
+- Add udev support for Serial-Devices
+- Allow to get properties for Atmo and Karatedevices to limit LED numbers configurable
+- Philips Hue: Add basic support for the Play Gradient Lightstrip
+- WLED: Support of ["live" property] (https://github.com/Aircoookie/WLED/issues/1308) (#1095)
+- WLED: Brightness overwrite control by configuration
+- WLED: Allow to disable WLED synchronization when streaming via hyperion
+- WLED: Support storing/restoring state (#1101)
+- Adalight: Fix LED Num for non analogue output in arduino firmware
+
+- Allow to blacklist LEDs in layout via UI
+- Live Video image to LedLayout preview (#1136)
+
+#### Other
+
+- Effects: Support Custom Effect Templates in UI for custom effect creation and configuration
+- Effects: Custom effect separation in the systray menu
+
+- New languages - Portuguese (Std/Brazil) & Norwegian (Bokmål)
+- New Flags: Russia, Cameroon, Great Britain, England, Scotland
+
+- Provide cross compilation on x86_64 for developers using docker. This includes the ability to use local code, as well as build incrementally
 
 ### Changed
-- Updated dependency rpi_ws281x to latest upstream
-- Fix High CPU load (RPI3B+) (#1013)
-- Nanoleaf: Consider Nanoleaf-Shape Controlers
+
+- Grabbers use now precise timings for better timing accuracy
+
+- Nanoleaf: Consider Nanoleaf-Shape Controllers
 - LED-Devices: Show HW-Ledcount in all setting levels
 
-- Documentation: Add link to [Hyperion-py](https://github.com/dermotduffy/hyperion-py)
+- System Log Screen: Support to copy loglines, system info and status of the current instance to the clipboard (to share it for investigation)
+
+- Updated dependency rpi_ws281x to latest upstream
+- Fix High CPU load (RPI3B+) (#1013)
 
 ### Fixed
 
-- Fix issue #1127: LED-Devices: Correct total packet count in tpm2net implementation
-- LED-Hue: Proper black in Entertainement mode if min brightness is set
+- Active grabbers are displayed correctly after updating the WebUI
+- Issue Crop values are checked against decimated resolution (#1160)
+- Framebuffer grabber is deactivated in case of error
+- Fix/no signal detection (#1087)
+
+- Fix that global settings were not correctly reflected across instances after updates in other non default instance (#1131,#1186,#1188)
+- Fix UI: Handle error scenario properly, when last instance number used does not exist any longer.
+- UI Allow to have password handled by Password-Manager (#1263)
+
+- Fixed effect freezing during startup
+- Effects were not started from tray (#1199)
+- Interrupt effect on timeout (#1013)
+- Fixed color and effect handling and duplicate priorities (#993,#1113,#1216)
+- Stop background effect, when it gets out of scope (to not use resources unnecessarily)
+- Custom Effect Templates (schemas) are now loaded
+- Effects: Uploaded images were not found executing custom image effects
+- "LED Test" effect description is in wrong order (#1229)
+
+- LED-Devices: Only consider Hardware LED count (#673)
+- LED-Devices: Correct total packet count in tpm2net implementation (#1127)
+- LED-Hue: Proper black in Entertainment mode if min brightness is set
 - LED-Hue: Minor fix of setColor command
-- Nanoleaf: Fix,if external control mode cannot be set
-- Fix issue #1229: "LED Test" effect description is in wrong order
+- Nanoleaf: Fixed behaviour, if external control mode cannot be set
+
+- System Log Screen: Fixed Auto-Scrolling, Update Look & Feel, Works across multiple Browser tabs/windows, as log stream is not stopped by a new UI
+
+- Rename Instance and Change Password: Modal did not close
+- Read-Only mode was not handled in the SysInfo function
+
+- WebSockets: Handling of fragmented frames fixed
+- Fixed libcec dependencies
+
+- General language and grammar updates
 
 ### Removed
 

assets/webconfig/content/login.html

@@ -8,12 +8,12 @@ <h3 class="panel-title">Login</h3>
         <div class="panel-body">
           <form>
             <div class="form-group">
-              <input type="hidden" name="username" class="form-control" type="text" id="username" value="hyperion"/>
-              <input name="password" class="form-control" type="password" id="password" placeholder="Password" autocomplete="off" />
+              <input type="name="username" class="form-control" type="text" id="username" value="Hyperion" disabled/></br>
+              <input name="password" class="form-control" type="password" id="password" placeholder="Password" autocomplete="off"/>
               <input name="show_pw" type="checkbox" id="show_pw" /><label for="show_pw">Show/Hide Password</label>
             </div>
             <div class="form-group">
-              <button type="submit" class="btn btn-sm btn-success" id="btn_password" onclick="requestAuthorization(document.getElementById('password').value); return false;" disabled><i class="fa fa-fw fa-unlock"></i>Login</button>
+              <button type="submit" class="btn btn-sm btn-success" id="btn_password" onclick="requestAuthorization(document.getElementById('password').value); return false;"><i class="fa fa-fw fa-unlock"></i>Login</button>
             </div>
           </form>
         </div>
@@ -26,8 +26,12 @@ <h3 class="panel-title">Login</h3>
   removeOverlay();
 
   $('#password').off().on('input', function (e) {
-    if (e.currentTarget.value.length >= 8)
-      $('#btn_password').removeAttr('disabled');
+    if (e.currentTarget.value.length >= 8) {
+      $('#btn_password').prop('disabled', false);
+    }
+    else {
+      $('#btn_password').prop('disabled', true);
+    }
   });
 
   $('#show_pw').off().on('change', function (e) {

assets/webconfig/i18n/en.json

@@ -11,7 +11,9 @@
     "InfoDialog_nowrite_text": "Hyperion can't write to your current loaded configuration file. Please repair the file permissions to proceed.",
     "InfoDialog_nowrite_title": "write permission error!",
     "infoDialog_password_current_text": "Current password",
+    "infoDialog_password_minimum_length": "Passwords must be minimum 8 characters.",
     "infoDialog_password_new_text": "New password",
+    "infoDialog_username_text": "Username",
     "about_3rd_party_licenses": "3rd party licenses",
     "about_3rd_party_licenses_error": "We had trouble collecting 3rd party licenses information from web. <br />Please follow this link to the GitHub Resource.",
     "about_build": "Build",
@@ -464,17 +466,17 @@
     "edt_conf_v4l2_flip_expl": "This allows you to flip the image horizontally, vertically, or both.",
     "edt_conf_v4l2_flip_title": "Image flip",
     "edt_conf_v4l2_fpsSoftwareDecimation_title": "Software frame skipping",
-    "edt_conf_v4l2_fpsSoftwareDecimation_expl": "To save resources every n'th frame will be processed only. For ex. if grabber is set to 30FPS with this option set to 5 the final result will be around 6FPS (1 - disabled)",
+    "edt_conf_v4l2_fpsSoftwareDecimation_expl": "To save resources every n'th frame will be processed only. For ex. if grabber is set to 30fps with this option set to 5 the final result will be around 6fps",
     "edt_conf_v4l2_encoding_title": "Encoding format",
     "edt_conf_v4l2_encoding_expl": "Force video encoding for multiformat capable grabbers",
     "edt_conf_v4l2_hardware_brightness_title": "Hardware brightness control",
-    "edt_conf_v4l2_hardware_brightness_expl": "Set hardware brightness if device supports it, check logs (0=disabled)",
+    "edt_conf_v4l2_hardware_brightness_expl": "Set hardware brightness",
     "edt_conf_v4l2_hardware_contrast_title": "Hardware contrast control",
-    "edt_conf_v4l2_hardware_contrast_expl": "Set hardware contrast if device supports it, check logs (0=disabled)",
+    "edt_conf_v4l2_hardware_contrast_expl": "Set hardware contrast",
     "edt_conf_v4l2_hardware_hue_title": "Hardware hue control",
-    "edt_conf_v4l2_hardware_hue_expl": "Set hardware hue if device supports it, check logs (0=disabled)",
+    "edt_conf_v4l2_hardware_hue_expl": "Set hardware hue",
     "edt_conf_v4l2_hardware_saturation_title": "Hardware saturation control",
-    "edt_conf_v4l2_hardware_saturation_expl": "Set hardware saturation if device supports it, check logs (0=disabled)",
+    "edt_conf_v4l2_hardware_saturation_expl": "Set hardware saturation",
     "edt_conf_v4l2_hardware_set_defaults": "Default hardware controls",
     "edt_conf_v4l2_hardware_set_defaults_tip": "Set device's default values for brightness, contrast, hue and saturation",
     "edt_conf_v4l2_noSignalCounterThreshold_title": "Signal Counter Threshold",

assets/webconfig/js/content_colors.js

@@ -22,7 +22,7 @@ $(document).ready(function () {
     //blackborder
     $('#conf_cont').append(createRow('conf_cont_blackborder'));
     $('#conf_cont_blackborder').append(createOptPanel('fa-photo', $.i18n("edt_conf_bb_heading_title"), 'editor_container_blackborder', 'btn_submit_blackborder'));
-    $('#conf_cont_blackborder').append(createHelpTable(window.schema.blackborderdetector.properties, $.i18n("edt_conf_bb_heading_title"), "blackborderHelpPanelId"))
+    $('#conf_cont_blackborder').append(createHelpTable(window.schema.blackborderdetector.properties, $.i18n("edt_conf_bb_heading_title"), "blackborderHelpPanelId"));
   }
   else {
     $('#conf_cont').addClass('row');

assets/webconfig/js/content_dashboard.js

@@ -10,7 +10,7 @@ $(document).ready(function () {
     instances_html += '<a id="active_instance_dropdown" class="dropdown-toggle" data-toggle="dropdown" href="#" style="text-decoration:none;display:flex;align-items:center;">';
     instances_html += '<div id="active_instance_friendly_name"></div>';
     instances_html += '<div id="btn_hypinstanceswitch" style="white-space:nowrap;"><span class="mdi mdi-lightbulb-group mdi-24px" style="margin-right:0;margin-left:5px;"></span><span class="mdi mdi-menu-down mdi-24px"></span></div>';
-    instances_html += '</a><ul id="hyp_inst_listing" class="dropdown-menu dropdown-alerts" style="cursor:pointer;"></ul>'
+    instances_html += '</a><ul id="hyp_inst_listing" class="dropdown-menu dropdown-alerts" style="cursor:pointer;"></ul>';
     instances_html += '</div></div>';
 
     instances_html += '<div class="panel-body">';
@@ -114,7 +114,7 @@ $(document).ready(function () {
 
   var jsonPort = window.serverConfig.jsonServer.port;
   $('#dash_jsonPort').html(jsonPort);
-  var wsPorts = window.serverConfig.webConfig.port + ' | ' + window.serverConfig.webConfig.sslPort
+  var wsPorts = window.serverConfig.webConfig.port + ' | ' + window.serverConfig.webConfig.sslPort;
   $('#dash_wsPorts').html(wsPorts);
 
   $('#dash_currv').html(window.currentVersion);

assets/webconfig/js/content_grabber.js

@@ -205,7 +205,7 @@ $(document).ready(function () {
     if (enumVals.length > 0) {
       if (deviceSelected === configuredDevice) {
         var configuredResolutionText = window.serverConfig.framegrabber.width + "x" + window.serverConfig.framegrabber.height;
-        var idx = $.inArray(configuredResolutionText, enumTitelVals)
+        var idx = $.inArray(configuredResolutionText, enumTitelVals);
         if (idx != -1) {
           enumDefaultVal = idx.toString();
         }
@@ -266,6 +266,10 @@ $(document).ready(function () {
         if ($.inArray(configuredFps, enumVals) != -1) {
           enumDefaultVal = configuredFps;
         }
+      } else if (deviceProperties.hasOwnProperty('default') && !jQuery.isEmptyObject(deviceProperties.default.video_input)) {
+          if (deviceProperties.default.video_input.resolution.fps) {
+            enumDefaultVal = deviceProperties.default.video_input.resolution.fps;
+          }
       }
       updateJsonEditorSelection(conf_editor_screen, 'root.framegrabber',
         'framerates', addSchemaElements, enumVals, [], enumDefaultVal, false);
@@ -413,7 +417,7 @@ $(document).ready(function () {
             contrast: { current: window.serverConfig.grabberV4L2.hardware_contrast },
             saturation: { current: window.serverConfig.grabberV4L2.hardware_saturation },
             hue: { current: window.serverConfig.grabberV4L2.hardware_hue }
-          }
+          };
           deviceProperties.properties = properties;
         }
       }
@@ -551,7 +555,7 @@ $(document).ready(function () {
     if (enumVals.length > 0) {
       if (deviceSelected === configuredDevice) {
         var configuredResolutionText = window.serverConfig.grabberV4L2.width + "x" + window.serverConfig.grabberV4L2.height;
-        var idx = $.inArray(configuredResolutionText, enumTitelVals)
+        var idx = $.inArray(configuredResolutionText, enumTitelVals);
         if (idx != -1) {
           enumDefaultVal = idx.toString();
         }
@@ -719,7 +723,7 @@ $(document).ready(function () {
       updateJsonEditorSelection(conf_editor_screen, 'root.framegrabber',
         'available_devices', {}, enumVals, enumTitelVals, enumDefaultVal, addSelect, false);
     }
-  }
+  };
 
   // build dynamic video input enum
   var updateVideoSourcesList = function (type, discoveryInfo) {
@@ -763,7 +767,7 @@ $(document).ready(function () {
     else {
       discoveryResult = {
         "video_sources": []
-      }
+      };
     }
 
     switch (type) {

assets/webconfig/js/content_leds.js

@@ -884,6 +884,8 @@ $(document).ready(function () {
             break;
           default:
             conf_editor.getEditor(specOptPath + "host").disable();
+            //Reset host value, to trigger getProperties via host value
+            conf_editor.getEditor(specOptPath + "host").setValue("");
             conf_editor.getEditor(specOptPath + "host").setValue(val);
             break;
         }
@@ -1199,7 +1201,8 @@ function saveLedConfig(genDefLayout = false) {
       result.smoothing = { enable: false };
 
       if (genDefLayout === true) {
-        if (devicesProperties[ledType][host].modelType === "Strip") {
+
+        if (!jQuery.isEmptyObject(devicesProperties) && devicesProperties[ledType][host].modelType === "Strip") {
           ledConfig = {
             "classic": {
               "top": hardwareLedCount / 2,
@@ -1269,8 +1272,6 @@ function saveLedConfig(genDefLayout = false) {
       break;
   }
 
-
-
   //Rewrite whole LED & Layout configuration, in case changes were done accross tabs and no default layout
   if (genDefLayout !== true) {
     result.ledConfig = getLedConfig();
@@ -1283,7 +1284,6 @@ function saveLedConfig(genDefLayout = false) {
 
 // build dynamic enum
 var updateSelectList = function (ledType, discoveryInfo) {
-
   // Only update, if ledType is equal of selected controller type and discovery info exists
   if (ledType !== $("#leddevices").val() || !discoveryInfo.devices) {
     return;
@@ -1369,19 +1369,18 @@ var updateSelectList = function (ledType, discoveryInfo) {
           else {
             enumTitelVals.push(host);
           }
+        }
 
-          addCustom = true;
-
-          // Select configured device
-          var configuredDeviceType = window.serverConfig.device.type;
-          var configuredHost = window.serverConfig.device.hostList;
-          if (ledType === configuredDeviceType && $.inArray(configuredHost, enumVals) != -1) {
-            enumDefaultVal = configuredHost;
-          }
-          else {
-            addSelect = true;
-            addCustom = true;
-          }
+        //Always allow to add custom configuration
+        addCustom = true;
+        // Select configured device
+        var configuredDeviceType = window.serverConfig.device.type;
+        var configuredHost = window.serverConfig.device.hostList;
+        if (ledType === configuredDeviceType && $.inArray(configuredHost, enumVals) != -1) {
+          enumDefaultVal = configuredHost;
+        }
+        else {
+          addSelect = true;
         }
       }
       break;

assets/webconfig/js/ledsim.js

@@ -17,8 +17,8 @@ $(document).ready(function () {
 
   var activeComponent = "";
 
-  const image = new Image()
-  image.src = "img/hyperion/logo_negativ.png",
+  const image = new Image();
+  image.src = "img/hyperion/logo_negativ.png";
 
   /// add prototype for simple canvas clear() method
   CanvasRenderingContext2D.prototype.clear = function () {