Troubleshooting and ...

- More i18n
- Easy use of mutual exclusion in JsonAPI with QMutexLocker
- Smoothing type "linear" hidden in the WebUI, because there is currently only one
- Message forwarding implemented again
- For compatibility to home assistants and other remote controls, "activeEffects" and "activeLedColor" has been added to the JSON-RPC
- FlatBuffer clear now the Priority on disconnect
- The information "available V4L2 devices" is now only displayed if the device list is not empty
- LED device "PiBlaster" excluded from OSX build

Author: Paulchen-Panther

assets/webconfig/i18n/de.json

@@ -565,12 +565,14 @@
 	"edt_conf_fw_proto_itemtitle" : "Proto Ziel",
 	"edt_conf_js_heading_title" : "JSON Server",
 	"edt_conf_fbs_heading_title" : "Flatbuffers Server",
+	"edt_conf_fbs_timeout_title" : "Zeitüberschreitung",
+	"edt_conf_fbs_timeout_expl" : "Wenn für die angegebene Zeit keine Daten empfangen werden, wird die Komponente (vorübergehend) deaktiviert",
 	"edt_conf_bobls_heading_title" : "Boblight Server",
 	"edt_conf_udpl_heading_title" : "UDP Listener",
 	"edt_conf_udpl_address_title" : "Adresse",
 	"edt_conf_udpl_address_expl" : "Die Adresse auf der UDP Pakete akzeptiert werden.",
 	"edt_conf_udpl_timeout_title" : "Zeitüberschreitung",
-	"edt_conf_udpl_timeout_expl" : "Wenn für die angegeben Zeit keine UDP Pakete empfangen werden, wird die Komponente (vorübergehend) deaktiviert",
+	"edt_conf_udpl_timeout_expl" : "Wenn für die angegebene Zeit keine UDP Pakete empfangen werden, wird die Komponente (vorübergehend) deaktiviert",
 	"edt_conf_udpl_shared_title" : "Gemeinsam genutzt",
 	"edt_conf_udpl_shared_expl" : "Wird gemeinsam über alle Hyperion Instanzen genutzt.",
 	"edt_conf_webc_heading_title" : "Web Konfiguration",

assets/webconfig/i18n/en.json

@@ -566,6 +566,8 @@
 	"edt_conf_fw_proto_itemtitle" : "Proto target",
 	"edt_conf_js_heading_title" : "JSON Server",
 	"edt_conf_fbs_heading_title" : "Flatbuffers Server",
+	"edt_conf_fbs_timeout_title" : "Timeout",
+	"edt_conf_fbs_timeout_expl" : "If no data are received for the given period, the component will be (soft) disabled.",
 	"edt_conf_bobls_heading_title" : "Boblight Server",
 	"edt_conf_udpl_heading_title" : "UDP Listener",
 	"edt_conf_udpl_address_title" : "Address",

assets/webconfig/js/content_effectsconfigurator.js

@@ -50,7 +50,6 @@ $(document).ready( function() {
 
 		fileReader.onload = function () {
 			imageData = this.result.split(',')[1];
-			console.log(imageData);
 			cbs.success(file.name);
 		};
 

assets/webconfig/js/ui_utils.js

@@ -587,6 +587,9 @@ function createHelpTable(list, phead){
 	{
 		if(list[key].access != 'system')
 		{
+			// break one iteration (in the loop), if the schema has the entry hidden=true
+			if ("options" in list[key] && "hidden" in list[key].options && (list[key].options.hidden))
+				continue;
 			var text = list[key].title.replace('title', 'expl');
 			tbody.appendChild(createTableRow([$.i18n(list[key].title), $.i18n(text)], false, false));
 
@@ -595,7 +598,9 @@ function createHelpTable(list, phead){
 				var ilist = sortProperties(list[key].items.properties);
 				for (ikey in ilist)
 				{
-
+					// break one iteration (in the loop), if the schema has the entry hidden=true
+					if ("options" in ilist[ikey] && "hidden" in ilist[ikey].options && (ilist[ikey].options.hidden))
+						continue;
 					var itext = ilist[ikey].title.replace('title', 'expl');
 					tbody.appendChild(createTableRow([$.i18n(ilist[ikey].title), $.i18n(itext)], false, false));
 				}

include/hyperion/Hyperion.h

@@ -326,12 +326,6 @@ public slots:
 	///
 	ColorAdjustment * getAdjustment(const QString& id);
 
-	///
-	/// Returns  MessageForwarder Object
-	/// @return instance of message forwarder object
-	///
-	MessageForwarder * getForwarder();
-
 	/// Tell Hyperion that the corrections have changed and the leds need to be updated
 	void adjustmentsUpdated();
 
@@ -345,7 +339,7 @@ public slots:
 	const bool clear(int priority);
 
 	///
-	/// Clears all priority channels. This will switch the leds off until a new priority is written.
+	/// @brief Clears all priority channels. This will switch the leds off until a new priority is written.
 	///
 	void clearall(bool forceClearAll=false);
 
@@ -416,6 +410,9 @@ public slots:
 	/// Signal which is emitted, when a new json message should be forwarded
 	void forwardJsonMessage(QJsonObject);
 
+	/// Signal which is emitted, when a new proto image should be forwarded
+	void forwardProtoMessage(Image<ColorRgb>);
+
 	///
 	/// @brief Is emitted from clients who request a videoMode change
 	///

include/hyperion/MessageForwarder.h

@@ -18,37 +18,86 @@
 #include <utils/ColorRgb.h>
 #include <utils/settings.h>
 #include <utils/Logger.h>
+#include <utils/Components.h>
+#include <utils/Image.h>
 
+// Hyperion includes
+#include <hyperion/PriorityMuxer.h>
+
+// Forward declaration
 class Hyperion;
+class QTcpSocket;
+class FlatBufferConnection;
 
 class MessageForwarder : public QObject
 {
 	Q_OBJECT
 public:
-
-	MessageForwarder(Hyperion* hyperion, const QJsonDocument & config);
+	MessageForwarder(Hyperion* hyperion);
 	~MessageForwarder();
 
 	void addJsonSlave(QString slave);
 	void addProtoSlave(QString slave);
 
-	bool protoForwardingEnabled();
-	bool jsonForwardingEnabled();
-	bool forwardingEnabled() { return jsonForwardingEnabled() || protoForwardingEnabled(); };
-	QStringList getProtoSlaves() const { return _protoSlaves; };
-	QStringList getJsonSlaves() const { return _jsonSlaves; };
-
 private slots:
 	///
 	/// @brief Handle settings update from Hyperion Settingsmanager emit or this constructor
 	/// @param type   settingyType from enum
 	/// @param config configuration object
 	///
-	void handleSettingsUpdate(const settings::type& type, const QJsonDocument& config);
+	void handleSettingsUpdate(const settings::type &type, const QJsonDocument &config);
+
+	///
+	/// @brief Handle component state change MessageForwarder
+	/// @param component  The component from enum
+	/// @param enable     The new state
+	///
+	void componentStateChanged(const hyperion::Components component, bool enable);
+
+	///
+	/// @brief Handle priority updates from Priority Muxer
+	/// @param  priority  The new visible priority
+	///
+	void handlePriorityChanges(const quint8 &priority);
+
+	///
+	/// @brief Forward message to all json slaves
+	/// @param message The JSON message to send
+	///
+	void forwardJsonMessage(const QJsonObject &message);
+
+	///
+	/// @brief Forward image to all proto slaves
+	/// @param image The PROTO image to send
+	///
+	void forwardProtoMessage(const Image<ColorRgb> &image);
+
+	///
+	/// @brief Forward message to a single json slave
+	/// @param message The JSON message to send
+	/// @param socket The TCP-Socket with the connection to the slave
+	///
+	void sendJsonMessage(const QJsonObject &message, QTcpSocket *socket);
 
 private:
-	Hyperion* _hyperion;
-	Logger*   _log;
-	QStringList   _protoSlaves;
+	/// Hyperion instance
+	Hyperion *_hyperion;
+
+	/// Logger instance
+	Logger   *_log;
+
+	/// Muxer instance
+	PriorityMuxer *_muxer;
+
+	// JSON connection for forwarding
 	QStringList   _jsonSlaves;
+
+	/// Proto connection for forwarding
+	QStringList _protoSlaves;
+	QList<FlatBufferConnection*> _forwardClients;
+
+	/// Flag if forwarder is enabled
+	bool _forwarder_enabled = true;
+
+	const int _priority;
 };

include/hyperion/PriorityMuxer.h

@@ -107,7 +107,7 @@ class PriorityMuxer : public QObject
 	///
 	/// @return The current priority
 	///
-	int getCurrentPriority() const;
+	int getCurrentPriority() const { return _currentPriority; }
 
 	///
 	/// Returns the state (enabled/disabled) of a specific priority channel
@@ -197,7 +197,7 @@ class PriorityMuxer : public QObject
 
 	///
 	/// @brief Emits whenever the visible priority has changed
-	/// @param  priority  The new visible prioritiy
+	/// @param  priority  The new visible priority
 	///
 	void visiblePriorityChanged(const quint8& priority);
 

include/jsonserver/JsonServer.h

@@ -49,17 +49,9 @@ private slots:
 	void closedConnection(void);
 
 public slots:
-
-	///
-	/// forward message to a single json slaves
-	///
-	/// @param message The JSON message to send
-	///
-	void sendMessage(const QJsonObject & message, QTcpSocket * socket);
-
 	///
 	/// @brief Handle settings update from Hyperion Settingsmanager emit or this constructor
-	/// @param type   settingyType from enum
+	/// @param type   settings type from enum
 	/// @param config configuration object
 	///
 	void handleSettingsUpdate(const settings::type& type, const QJsonDocument& config);

include/udplistener/UDPListener.h

@@ -76,11 +76,6 @@ public slots:
 	///
 	const bool setGlobalInput(const int priority, const std::vector<ColorRgb>& ledColors, const int timeout_ms = -1, const bool& clearEffect = true);
 
-	///
-	/// @brief forward clear to HyperionDaemon
-	///
-	void clearGlobalPriority(const int& _priority, const hyperion::Components& component);
-
 private slots:
 	///
 	/// Slot which is called when a client tries to create a new connection

include/utils/hyperion.h

@@ -1,5 +1,7 @@
 #pragma once
 
+#include <sstream>
+
 #include <hyperion/ColorAdjustment.h>
 #include <hyperion/MultiColorAdjustment.h>
 #include <hyperion/LedString.h>

libsrc/api/JsonAPI.cpp

@@ -14,6 +14,7 @@
 #include <QByteArray>
 #include <QDateTime>
 #include <QHostInfo>
+#include <QMutexLocker>
 
 // hyperion includes
 #include <utils/jsonschema/QJsonFactory.h>
@@ -55,9 +56,6 @@ JsonAPI::JsonAPI(QString peerAddress, Logger* log, QObject* parent, bool noListe
 
 	// notify hyperion about a jsonMessageForward
 	connect(this, &JsonAPI::forwardJsonMessage, _hyperion, &Hyperion::forwardJsonMessage);
-
-	_image_stream_mutex.unlock();
-	_led_stream_mutex.unlock();
 }
 
 void JsonAPI::handleMessage(const QString& messageString)
@@ -475,10 +473,10 @@ void JsonAPI::handleServerInfoCommand(const QJsonObject& message, const QString&
 	// BEGIN | The following entries are derecated but used to ensure backward compatibility with hyperion Classic remote control
 	// TODO Output the real transformation information instead of default
 
-		// host name
+		// HOST NAME
 		info["hostname"] = QHostInfo::localHostName();
 
-		// transform information (default values)
+		// TRANSFORM INFORMATION (DEFAULT VALUES)
 		QJsonArray transformArray;
 		for (const QString& transformId : _hyperion->getAdjustmentIds())
 		{
@@ -507,9 +505,66 @@ void JsonAPI::handleServerInfoCommand(const QJsonObject& message, const QString&
 
 			transformArray.append(transform);
 		}
-
 		info["transform"] = transformArray;
 
+		// ACTIVE EFFECT INFO
+		QJsonArray activeEffects;
+		const std::list<ActiveEffectDefinition> & activeEffectsDefinitions = _hyperion->getActiveEffects();
+		for (const ActiveEffectDefinition & activeEffectDefinition : activeEffectsDefinitions)
+		{
+			if (activeEffectDefinition.priority != PriorityMuxer::LOWEST_PRIORITY -1)
+			{
+				QJsonObject activeEffect;
+				activeEffect["script"] = activeEffectDefinition.script;
+				activeEffect["name"] = activeEffectDefinition.name;
+				activeEffect["priority"] = activeEffectDefinition.priority;
+				activeEffect["timeout"] = activeEffectDefinition.timeout;
+				activeEffect["args"] = activeEffectDefinition.args;
+				activeEffects.append(activeEffect);
+			}
+		}
+		info["activeEffects"] = activeEffects;
+
+		// ACTIVE STATIC LED COLOR
+		QJsonArray activeLedColors;
+		const Hyperion::InputInfo & priorityInfo = _hyperion->getPriorityInfo(_hyperion->getCurrentPriority());
+		if(priorityInfo.componentId == hyperion::COMP_COLOR && !priorityInfo.ledColors.empty())
+		{
+			QJsonObject LEDcolor;
+			// check if LED Color not Black (0,0,0)
+			if ((priorityInfo.ledColors.begin()->red +
+			priorityInfo.ledColors.begin()->green +
+			priorityInfo.ledColors.begin()->blue != 0))
+			{
+				QJsonObject LEDcolor;
+
+				// add RGB Value to Array
+				QJsonArray RGBValue;
+				RGBValue.append(priorityInfo.ledColors.begin()->red);
+				RGBValue.append(priorityInfo.ledColors.begin()->green);
+				RGBValue.append(priorityInfo.ledColors.begin()->blue);
+				LEDcolor.insert("RGB Value", RGBValue);
+
+				uint16_t Hue;
+				float Saturation, Luminace;
+
+				// add HSL Value to Array
+				QJsonArray HSLValue;
+				ColorSys::rgb2hsl(priorityInfo.ledColors.begin()->red,
+						priorityInfo.ledColors.begin()->green,
+						priorityInfo.ledColors.begin()->blue,
+						Hue, Saturation, Luminace);
+
+				HSLValue.append(Hue);
+				HSLValue.append(Saturation);
+				HSLValue.append(Luminace);
+				LEDcolor.insert("HSL Value", HSLValue);
+
+				activeLedColors.append(LEDcolor);
+			}
+		}
+		info["activeLedColor"] = activeLedColors;
+
 	// END
 
 	sendSuccessDataReply(QJsonDocument(info), command, tan);
@@ -952,7 +1007,8 @@ void JsonAPI::sendErrorReply(const QString &error, const QString &command, const
 
 void JsonAPI::streamLedcolorsUpdate(const std::vector<ColorRgb>& ledColors)
 {
-	if ( (_led_stream_timeout+100) < QDateTime::currentMSecsSinceEpoch() && _led_stream_mutex.tryLock(0) )
+	QMutexLocker lock(&_led_stream_mutex);
+	if ( (_led_stream_timeout+100) < QDateTime::currentMSecsSinceEpoch() )
 	{
 		_led_stream_timeout = QDateTime::currentMSecsSinceEpoch();
 		QJsonObject result;
@@ -973,14 +1029,13 @@ void JsonAPI::streamLedcolorsUpdate(const std::vector<ColorRgb>& ledColors)
 
 		// send the result
 		emit callbackMessage(_streaming_leds_reply);
-
-		_led_stream_mutex.unlock();
 	}
 }
 
 void JsonAPI::setImage(const Image<ColorRgb> & image)
 {
-	if ( (_image_stream_timeout+100) < QDateTime::currentMSecsSinceEpoch() && _image_stream_mutex.tryLock(0) )
+	QMutexLocker lock(&_image_stream_mutex);
+	if ( (_image_stream_timeout+100) < QDateTime::currentMSecsSinceEpoch() )
 	{
 		_image_stream_timeout = QDateTime::currentMSecsSinceEpoch();
 
@@ -994,8 +1049,6 @@ void JsonAPI::setImage(const Image<ColorRgb> & image)
 		result["image"] = "data:image/jpg;base64,"+QString(ba.toBase64());
 		_streaming_image_reply["result"] = result;
 		emit callbackMessage(_streaming_image_reply);
-
-		_image_stream_mutex.unlock();
 	}
 }