Merge remote-tracking branch 'origin/master' into temperture

Lord-Grey · Lord-Grey · commit 4bef160b15b8 · 2024-12-11T21:56:19.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Allow to force starting Hyperion in read-only mode (`--readonlyMode`)
 - JSON-API: Support to query for a dedicated set of configuration items for a set of instances
 - JSON-API: Support to save a dedicated set of configuration items for a set of instances
+- JSON-API: Limit update emission frequency: Images (25Hz), raw LED-Colors (40Hz) & LED-Device data (200Hz) 
+- Effects: Limit the maximum update rate to 200Hz
 
 **JSON-API**
 - New subscription support for event updates, i.e. `Suspend, Resume, Idle, idleResume, Restart, Quit`.
@@ -44,6 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Refactored: Python to enable parallel effect processing under Python 3.12
 - Fixed: Python 3.12 crashes (#1747)
 - osX Grabber: Use ScreenCaptureKit under macOS 15 and above
+- Removed maximum LED number constraint from Matrix layout schema which was not synced with the UI behaviour (#1804)
 
 **JSON-API**
 - Refactored JSON-API to ensure consistent authorization behaviour across sessions and single requests with token authorization.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -120,7 +120,7 @@ The amount of "%" must match with following arguments
 > TODO
 
 ## Visual Studio Code
-**We assume that you successfully compiled Hyperion with the [Compile HowTo](CompileHowto.md) WITHOUT Docker** \
+**We assume that you successfully compiled Hyperion with the [Compile HowTo](doc/development/CompileHowto.md) WITHOUT Docker** \
 If you want to use VSCode for development follow the steps.
 
 - Install [VSCode](https://code.visualstudio.com/). On Ubuntu 16.04+ you can also use the [Snapcraft VSCode](https://snapcraft.io/code) package.
diff --git a/dependencies/external/mbedtls b/dependencies/external/mbedtls
@@ -1 +1 @@
-Subproject commit 2ca6c285a0dd3f33982dd57299012dacab1ff206
+Subproject commit 107ea89daaefb9867ea9121002fbbdf926780e98
diff --git a/dependencies/external/protobuf b/dependencies/external/protobuf
@@ -1 +1 @@
-Subproject commit 3d9f7c430a5ae1385512908801492d4421c3cdb7
+Subproject commit 5864b5078a0187a1a16d4d2ed6f55972511d0a94
diff --git a/effects/candle.py b/effects/candle.py
@@ -20,6 +20,9 @@
 
 sleepTime = float(hyperion.args.get('sleepTime', 0.14))
 
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
+
 candles = hyperion.args.get('candles', "all")
 ledlist = hyperion.args.get('ledlist', "1")
 
diff --git a/effects/gif.py b/effects/gif.py
@@ -11,6 +11,10 @@
 grayscale = bool(hyperion.args.get('grayscale', False))
 
 sleepTime = 1./framesPerSecond
+
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
+
 imageFrameList = []
 
 if imageData:
diff --git a/effects/ledtest-seq.py b/effects/ledtest-seq.py
@@ -4,6 +4,9 @@
 # Get parameters
 sleepTime = float(hyperion.args.get('sleepTime', 0.5))
 
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
+
 def TestRgb( iteration ):
 
     switcher = {
diff --git a/effects/ledtest.py b/effects/ledtest.py
@@ -11,6 +11,9 @@
 testleds = hyperion.args.get('testleds', "all")
 ledlist = hyperion.args.get('ledlist', "1")
 
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
+
 testlist = ()
 if (testleds == "list") and (type(ledlist) is str):
 	for s in ledlist.split(','):
diff --git a/effects/plasma.py b/effects/plasma.py
@@ -6,6 +6,9 @@
 height = hyperion.imageHeight()
 sleepTime = float(hyperion.args.get('sleepTime', 0.2))
 
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
+
 def mapto(x, in_min, in_max, out_min, out_max):
 	return float((x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min)
 
diff --git a/effects/running_dots.py b/effects/running_dots.py
@@ -4,8 +4,11 @@
 sleepTime  = float(hyperion.args.get('speed', 1.5)) * 0.005
 whiteLevel = int(hyperion.args.get('whiteLevel', 0))
 lvl        = int(hyperion.args.get('colorLevel', 220))
+
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
 
-# check value
+# check value
 whiteLevel = min( whiteLevel, 254 )
 lvl        = min( lvl, 255 )
 
diff --git a/effects/shutdown.py b/effects/shutdown.py
@@ -21,6 +21,9 @@ def setPixel(x,y,rgb):
 
 imageData      = bytearray(height * width * (0,0,0))
 
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
+
 # Start the write data loop
 if initialBlink:
 	for i in range(6):
diff --git a/effects/sparks.py b/effects/sparks.py
@@ -8,6 +8,9 @@
 color        = list(hyperion.args.get('color', (255,255,255)))
 randomColor  = bool(hyperion.args.get('random-color', False))
 
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
+
 # Check parameters
 rotationTime = max(0.1, rotationTime)
 
diff --git a/effects/swirl.py b/effects/swirl.py
@@ -22,7 +22,10 @@ def getPoint(rand = True ,x = 0.5, y = 0.5):
 def getSTime(rt, steps = 360):
 	rt = float(rt)
 	sleepTime = max(0.1, rt) / steps
-	
+
+	# Limit update rate
+	sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
+
 	# adapt sleeptime to hardware
 	minStepTime= float(hyperion.latchTime)/1000.0
 	if minStepTime == 0: minStepTime = 0.001
diff --git a/effects/traces.py b/effects/traces.py
@@ -10,6 +10,9 @@
 if minStepTime == 0: minStepTime = 0.001
 factor      = 1 if sleepTime > minStepTime else int(math.ceil(minStepTime/sleepTime))
 
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
+
 runners = [
 	{ "i":0, "pos":0, "c":0, "step":9, "lvl":255},
 	{ "i":1, "pos":0, "c":0, "step":8, "lvl":255},
diff --git a/effects/trails.py b/effects/trails.py
@@ -11,7 +11,10 @@
 color = list(hyperion.args.get('color', (255,255,255)))
 randomise = bool(hyperion.args.get('random', False))
 iWidth = hyperion.imageWidth()
-iHeight = hyperion.imageHeight()
+iHeight = hyperion.imageHeight()
+
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
 
 class trail:
 	def __init__(self):
diff --git a/effects/x-mas.py b/effects/x-mas.py
@@ -4,7 +4,10 @@
 sleepTime   = float(hyperion.args.get('sleepTime', 1000))/1000.0
 length = hyperion.args.get('length', 1)
 color1 = hyperion.args.get('color1', (255,255,255))
-color2 = hyperion.args.get('color2', (255,0,0))
+color2 = hyperion.args.get('color2', (255,0,0))
+
+# Limit update rate
+sleepTime = max(hyperion.lowestUpdateInterval(), sleepTime)
 
 # Initialize the led data
 i = 0
diff --git a/include/api/JsonAPI.h b/include/api/JsonAPI.h
@@ -50,6 +50,8 @@ class JsonAPI : public API
 	///
 	void initialize();
 
+	QSharedPointer<JsonCallbacks> getCallBack() const;
+
 public slots:
 
 private slots:
@@ -82,7 +84,7 @@ private slots:
 	///
 	/// Signal emits with the reply message provided with handleMessage()
 	///
-	void callbackMessage(QJsonObject);
+	void callbackReady(QJsonObject);
 
 	///
 	/// Signal emits whenever a JSON-message should be forwarded
diff --git a/include/api/JsonCallbacks.h b/include/api/JsonCallbacks.h
@@ -93,7 +93,7 @@ class JsonCallbacks : public QObject
 	/// @brief Emits whenever a new json mesage callback is ready to send
 	/// @param The JsonObject message
 	///
-	void newCallback(QJsonObject);
+	void callbackReady(QJsonObject);
 
 private slots:
 	///
@@ -182,6 +182,8 @@ private slots:
 
 	/// construct callback msg
 	void doCallback(Subscription::Type cmd, const QVariant& data);
+	void doCallback(Subscription::Type cmd, const QJsonArray& data);
+	void doCallback(Subscription::Type cmd, const QJsonObject& data);
 
 	Logger *_log;
 	Hyperion* _hyperion;
diff --git a/include/effectengine/Effect.h b/include/effectengine/Effect.h
@@ -103,4 +103,6 @@ class Effect : public QThread
 	QImage          _image;
 	QPainter*       _painter;
 	QVector<QImage> _imageStack;
+
+	double	_lowestUpdateIntervalInSeconds;
 };
diff --git a/include/effectengine/EffectModule.h b/include/effectengine/EffectModule.h
@@ -21,28 +21,29 @@ class EffectModule : public QObject
 
 	// Wrapper methods for Python interpreter extra buildin methods
 	static PyMethodDef effectMethods[];
-	static PyObject* wrapSetColor(PyObject* self, PyObject* args);
-	static PyObject* wrapSetImage(PyObject* self, PyObject* args);
-	static PyObject* wrapGetImage(PyObject* self, PyObject* args);
-	static PyObject* wrapAbort(PyObject* self, PyObject* args);
-	static PyObject* wrapImageShow(PyObject* self, PyObject* args);
-	static PyObject* wrapImageLinearGradient(PyObject* self, PyObject* args);
-	static PyObject* wrapImageConicalGradient(PyObject* self, PyObject* args);
-	static PyObject* wrapImageRadialGradient(PyObject* self, PyObject* args);
-	static PyObject* wrapImageSolidFill(PyObject* self, PyObject* args);
-	static PyObject* wrapImageDrawLine(PyObject* self, PyObject* args);
-	static PyObject* wrapImageDrawPoint(PyObject* self, PyObject* args);
-	static PyObject* wrapImageDrawRect(PyObject* self, PyObject* args);
-	static PyObject* wrapImageDrawPolygon(PyObject* self, PyObject* args);
-	static PyObject* wrapImageDrawPie(PyObject* self, PyObject* args);
-	static PyObject* wrapImageSetPixel(PyObject* self, PyObject* args);
-	static PyObject* wrapImageGetPixel(PyObject* self, PyObject* args);
-	static PyObject* wrapImageSave(PyObject* self, PyObject* args);
-	static PyObject* wrapImageMinSize(PyObject* self, PyObject* args);
-	static PyObject* wrapImageWidth(PyObject* self, PyObject* args);
-	static PyObject* wrapImageHeight(PyObject* self, PyObject* args);
-	static PyObject* wrapImageCRotate(PyObject* self, PyObject* args);
-	static PyObject* wrapImageCOffset(PyObject* self, PyObject* args);
-	static PyObject* wrapImageCShear(PyObject* self, PyObject* args);
-	static PyObject* wrapImageResetT(PyObject* self, PyObject* args);
+	static PyObject* wrapSetColor              (PyObject *self, PyObject *args);
+	static PyObject* wrapSetImage              (PyObject *self, PyObject *args);
+	static PyObject* wrapGetImage              (PyObject *self, PyObject *args);
+	static PyObject* wrapAbort                 (PyObject *self, PyObject *args);
+	static PyObject* wrapImageShow             (PyObject *self, PyObject *args);
+	static PyObject* wrapImageLinearGradient   (PyObject *self, PyObject *args);
+	static PyObject* wrapImageConicalGradient  (PyObject *self, PyObject *args);
+	static PyObject* wrapImageRadialGradient   (PyObject *self, PyObject *args);
+	static PyObject* wrapImageSolidFill        (PyObject *self, PyObject *args);
+	static PyObject* wrapImageDrawLine         (PyObject *self, PyObject *args);
+	static PyObject* wrapImageDrawPoint        (PyObject *self, PyObject *args);
+	static PyObject* wrapImageDrawRect         (PyObject *self, PyObject *args);
+	static PyObject* wrapImageDrawPolygon      (PyObject *self, PyObject *args);
+	static PyObject* wrapImageDrawPie          (PyObject *self, PyObject *args);
+	static PyObject* wrapImageSetPixel         (PyObject *self, PyObject *args);
+	static PyObject* wrapImageGetPixel         (PyObject *self, PyObject *args);
+	static PyObject* wrapImageSave             (PyObject *self, PyObject *args);
+	static PyObject* wrapImageMinSize          (PyObject *self, PyObject *args);
+	static PyObject* wrapImageWidth            (PyObject *self, PyObject *args);
+	static PyObject* wrapImageHeight           (PyObject *self, PyObject *args);
+	static PyObject* wrapImageCRotate          (PyObject *self, PyObject *args);
+	static PyObject* wrapImageCOffset          (PyObject *self, PyObject *args);
+	static PyObject* wrapImageCShear           (PyObject *self, PyObject *args);
+	static PyObject* wrapImageResetT           (PyObject *self, PyObject *args);
+	static PyObject* wrapLowestUpdateInterval  (PyObject* self, PyObject* args);
 };
diff --git a/include/hyperion/Hyperion.h b/include/hyperion/Hyperion.h
@@ -2,6 +2,7 @@
 
 // stl includes
 #include <list>
+#include <chrono>
 
 // QT includes
 #include <QString>
@@ -11,6 +12,7 @@
 #include <QJsonValue>
 #include <QJsonArray>
 #include <QMap>
+#include <QElapsedTimer>
 
 // hyperion-utils includes
 #include <utils/Image.h>
@@ -604,4 +606,14 @@ private slots:
 	/// Boblight instance
 	BoblightServer* _boblightServer;
 #endif
+
+	QElapsedTimer _imageTimer;  // Timer for controlling image emission frequency
+	QElapsedTimer _rawLedDataTimer;  // Timer for controlling rawLedColors emission frequency
+	QElapsedTimer _ledDeviceDataTimer; // Timer for controlling LedDevice data emission frequency
+	qint64 _lastImageEmission;  // Last timestamp of image signal emission
+	qint64 _lastRawLedDataEmission;  // Last timestamp of rawLedColors signal emission
+	qint64 _lastLedDeviceDataEmission; // Last timestamp of ledDeviceData signal emission
+	std::chrono::milliseconds _imageEmissionInterval;
+	std::chrono::milliseconds _rawLedDataEmissionInterval;
+	std::chrono::milliseconds _ledDeviceDataEmissionInterval;
 };
diff --git a/libsrc/api/JsonAPI.cpp b/libsrc/api/JsonAPI.cpp
@@ -86,6 +86,11 @@ JsonAPI::JsonAPI(QString peerAddress, Logger *log, bool localConnection, QObject
 	_jsonCB = QSharedPointer<JsonCallbacks>(new JsonCallbacks( _log, _peerAddress, parent));
 }
 
+QSharedPointer<JsonCallbacks> JsonAPI::getCallBack() const
+{
+	return _jsonCB;
+}
+
 void JsonAPI::initialize()
 {
 	// init API, REQUIRED!
@@ -98,9 +103,6 @@ void JsonAPI::initialize()
 	// listen for killed instances
 	connect(_instanceManager, &HyperionIManager::instanceStateChanged, this, &JsonAPI::handleInstanceStateChange);
 
-	// pipe callbacks from subscriptions to parent
-	connect(_jsonCB.data(), &JsonCallbacks::newCallback, this, &JsonAPI::callbackMessage);
-
 	// notify hyperion about a jsonMessageForward
 	if (_hyperion != nullptr)
 	{
@@ -1547,7 +1549,7 @@ void JsonAPI::sendSuccessReply(const JsonApiCommand& cmd)
 
 void JsonAPI::sendSuccessReply(const QString &command, int tan, InstanceCmd::Type isInstanceCmd)
 {
-	emit callbackMessage(getBasicCommandReply(true, command, tan , isInstanceCmd));
+	emit callbackReady(getBasicCommandReply(true, command, tan , isInstanceCmd));
 }
 
 void JsonAPI::sendSuccessDataReply(const QJsonValue &infoData, const JsonApiCommand& cmd)
@@ -1582,7 +1584,7 @@ void JsonAPI::sendSuccessDataReplyWithError(const QJsonValue &infoData, const QS
 		reply["errorData"] = errorsArray;
 	}
 
-	emit callbackMessage(reply);
+	emit callbackReady(reply);
 }
 
 void JsonAPI::sendErrorReply(const QString &error, const JsonApiCommand& cmd)
@@ -1611,7 +1613,7 @@ void JsonAPI::sendErrorReply(const QString &error, const QStringList& errorDetai
 		reply["errorData"] = errorsArray;
 	}
 
-	emit callbackMessage(reply);
+	emit callbackReady(reply);
 }
 
 void JsonAPI::sendNewRequest(const QJsonValue &infoData, const JsonApiCommand& cmd)
@@ -1631,7 +1633,7 @@ void JsonAPI::sendNewRequest(const QJsonValue &infoData, const QString &command,
 
 	request["info"] = infoData;
 
-	emit callbackMessage(request);
+	emit callbackReady(request);
 }
 
 void JsonAPI::sendNoAuthorization(const JsonApiCommand& cmd)
diff --git a/libsrc/api/JsonCallbacks.cpp b/libsrc/api/JsonCallbacks.cpp
diff --git a/libsrc/effectengine/Effect.cpp b/libsrc/effectengine/Effect.cpp
diff --git a/libsrc/effectengine/EffectModule.cpp b/libsrc/effectengine/EffectModule.cpp
diff --git a/libsrc/hyperion/Hyperion.cpp b/libsrc/hyperion/Hyperion.cpp
diff --git a/libsrc/hyperion/schema/schema-ledConfig.json b/libsrc/hyperion/schema/schema-ledConfig.json
diff --git a/libsrc/jsonserver/JsonClientConnection.cpp b/libsrc/jsonserver/JsonClientConnection.cpp
diff --git a/libsrc/leddevice/dev_net/ProviderRestApi.cpp b/libsrc/leddevice/dev_net/ProviderRestApi.cpp
diff --git a/libsrc/leddevice/dev_net/ProviderRestApi.h b/libsrc/leddevice/dev_net/ProviderRestApi.h
diff --git a/libsrc/webserver/WebJsonRpc.cpp b/libsrc/webserver/WebJsonRpc.cpp
diff --git a/libsrc/webserver/WebJsonRpc.h b/libsrc/webserver/WebJsonRpc.h
diff --git a/libsrc/webserver/WebSocketClient.cpp b/libsrc/webserver/WebSocketClient.cpp
