mDNS Support (#1452)

* Allow build, if no grabbers are enabled * Align available functions to right Qt version * Update to next development version * Align available functions to right Qt version * fix workflows (apt/nightly) * Disable QNetworkConfigurationManager deprecation warnings * Initial go on Smart Pointers * Add Deallocation * Correct QT_WARNING_DISABLE_DEPRECATED (available since 5.9) * Cluster Build Variables * Hyperion Light * Address build warnings * Hyperion Light - UI * Update Protobuf to latest master * Removed compiler warnings * Added restart ability to systray * Correct Protobuf * Ignore 'no-return' warning on protobuf build * hyperion-remote: Fix auto discovery of hyperion server * Fix Qt version override * Update changelog * Remove Grabber Components, if no Grabber exists * Standalone Grabber - Fix fps default * Remote Control - Have Source Selction accrosswhole screen * Enable Blackborder detection only, if relevant input sources available * Enable Blackborder detection only, if relevant input sources available * Remote UI - rearrange containers * Checkout * Fix compilation on windows * Re-added qmdnsengine template cmake * chrono added for linux * Removed existing AVAHI/Bonjour, allow to enable/disable mDNS * hyperiond macos typo fix * Fix macOS Bundle build * Fix macOS bundle info details * Correct CMake files * Removed existing AVAHI/Bonjour (2) * Share hyperion's services via mDNS * Add mDNS Browser and mDNS for LED-Devices * Support mDNS discovery for standalone grabbers * Remove ZLib Dependency & Cleanup * mDNS - hanle 2.local2 an ".local." domains equally * Hue - Link discovery to bridge class, workaround port 443 for mDNS discovery * Fix save button state when switching between devices * Removed sessions (of other hyperions) * mDNS Publisher - Simplify service naming * mDNS refactoring & Forwarder discovery * mDNS Updates to use device service name * Consistency of standalone grabbers with mDNS Service Registry * Merge branch 'hyperion-project:master' into mDNS * Start JSON and WebServers only after Instance 0 is available * Remove bespoke qDebug Output again * MDNS updates and refactor Forwarder * Minor updates * Upgrade to CMake 3.1 * typo * macOS fix * Correct merge * - Remove dynamic linker flag from standalone dispmanX Grabber - Added ability to use system qmdns libs * Cec handler library will load at runtime * typo fix * protobuf changes * mDNS changes for Windows/macOS * test window build qmdnsengine * absolute path to protobuf cmake dir * Rework Hue Wizard supporting mDNS * LED-Devices - Retry support + Refactoring (excl. Hue) * LED-Devices - Refactoring/Retry support Hue + additional alignments * Address LGTM findings * Fix CI-Build, revert test changes * Build Windows in Release mode to avoid python problem * Correct that WebServerObject is available earlier * Ensure that instance name in logs for one instance are presented * Update content LEDs * Rework mDNS Address lookup * Fix LED UI * Fix for non mDNS Services (ignore default port) * Disbale device when now input is available * Revert back some updates, ensure last color is updated when switched on * Handle reopening case and changed IP, port for API-calls * Add UPD-DDP Device * WLED support for DDP * Fix printout * LEDDevice - Allow more retries, udapte defaults * LED-Net Devices - Select Custom device, if configured Co-authored-by: Paulchen Panther <16664240+Paulchen-Panther@users.noreply.github.com> Co-authored-by: Paulchen Panther <Paulchen-Panter@protonmail.com>
2025-03-01 10:33:28 +00:00 · 2022-05-01 19:42:47 +02:00
parent 3ef4ebc1a4
commit e9936e131b
148 changed files with 5885 additions and 4459 deletions
--- a/libsrc/leddevice/dev_net/LedDeviceWled.cpp
+++ b/libsrc/leddevice/dev_net/LedDeviceWled.cpp
@@ -1,11 +1,18 @@
 // Local-Hyperion includes
 #include "LedDeviceWled.h"

+#include <chrono>
+
 #include <utils/QStringUtils.h>
 #include <utils/WaitTime.h>
-#include <QThread>

-#include <chrono>
+// mDNS discover
+#ifdef ENABLE_MDNS
+#include <mdns/MdnsBrowser.h>
+#include <mdns/MdnsServiceRegister.h>
+#endif
+#include <utils/NetUtils.h>
+#include <utils/version.hpp>

 // Constants
 namespace {
@@ -13,16 +20,22 @@ namespace {
 const bool verbose = false;

 // Configuration settings
-const char CONFIG_ADDRESS[] = "host";
+const char CONFIG_HOST[] = "host";
+const char CONFIG_STREAM_PROTOCOL[] = "streamProtocol";
 const char CONFIG_RESTORE_STATE[] = "restoreOriginalState";
 const char CONFIG_BRIGHTNESS[] = "brightness";
 const char CONFIG_BRIGHTNESS_OVERWRITE[] = "overwriteBrightness";
 const char CONFIG_SYNC_OVERWRITE[] = "overwriteSync";

-// UDP elements
-const quint16 STREAM_DEFAULT_PORT = 19446;
+const char DEFAULT_STREAM_PROTOCOL[] = "DDP";
+
+// UDP-RAW
+const int UDP_STREAM_DEFAULT_PORT = 19446;
 const int UDP_MAX_LED_NUM = 490;

+// DDP
+const char WLED_VERSION_DDP[] = "0.11.0";
+
 // WLED JSON-API elements
 const int API_DEFAULT_PORT = -1; //Use default port per communication scheme

@@ -46,7 +59,7 @@ constexpr std::chrono::milliseconds DEFAULT_IDENTIFY_TIME{ 2000 };
 } //End of constants

 LedDeviceWled::LedDeviceWled(const QJsonObject &deviceConfig)
-	: ProviderUdp(deviceConfig)
+	: ProviderUdp(deviceConfig), LedDeviceUdpDdp(deviceConfig), LedDeviceUdpRaw(deviceConfig)
 	  ,_restApi(nullptr)
 	  ,_apiPort(API_DEFAULT_PORT)
 	  ,_isBrightnessOverwrite(DEFAULT_IS_BRIGHTNESS_OVERWRITE)
@@ -54,7 +67,12 @@ LedDeviceWled::LedDeviceWled(const QJsonObject &deviceConfig)
 	  ,_isSyncOverwrite(DEFAULT_IS_SYNC_OVERWRITE)
 	  ,_originalStateUdpnSend(false)
 	  ,_originalStateUdpnRecv(true)
+	  ,_isStreamDDP(true)
 {
+#ifdef ENABLE_MDNS
+	QMetaObject::invokeMethod(&MdnsBrowser::getInstance(), "browseForServiceType",
+							   Qt::QueuedConnection, Q_ARG(QByteArray, MdnsServiceRegister::getServiceType(_activeDeviceType)));
+#endif
 }

 LedDeviceWled::~LedDeviceWled()
@@ -70,25 +88,30 @@ LedDevice* LedDeviceWled::construct(const QJsonObject &deviceConfig)

 bool LedDeviceWled::init(const QJsonObject &deviceConfig)
 {
-	bool isInitOK = false;
+	bool isInitOK {false};

-	// Initialise LedDevice sub-class, ProviderUdp::init will be executed later, if connectivity is defined
-	if ( LedDevice::init(deviceConfig) )
+	QString streamProtocol = _devConfig[CONFIG_STREAM_PROTOCOL].toString(DEFAULT_STREAM_PROTOCOL);
+
+	if (streamProtocol != DEFAULT_STREAM_PROTOCOL)
 	{
-		// Initialise LedDevice configuration and execution environment
-		int configuredLedCount = this->getLedCount();
-		Debug(_log, "DeviceType   : %s", QSTRING_CSTR( this->getActiveDeviceType() ));
-		Debug(_log, "LedCount     : %d", configuredLedCount);
-		Debug(_log, "ColorOrder   : %s", QSTRING_CSTR( this->getColorOrder() ));
-		Debug(_log, "LatchTime    : %d", this->getLatchTime());
+		_isStreamDDP = false;
+	}
+	Debug(_log, "Stream protocol   : %s", QSTRING_CSTR(streamProtocol));
+	Debug(_log, "Stream DDP        : %d", _isStreamDDP);

-		if (configuredLedCount > UDP_MAX_LED_NUM)
-		{
-			QString errorReason = QString("Device type %1 can only be run with maximum %2 LEDs!").arg(this->getActiveDeviceType()).arg(UDP_MAX_LED_NUM);
-			this->setInError ( errorReason );
-			return false;
-		}
+	if (_isStreamDDP)
+	{
+		LedDeviceUdpDdp::init(deviceConfig);
+	}
+	else
+	{
+		_devConfig["port"] = UDP_STREAM_DEFAULT_PORT;
+		LedDeviceUdpRaw::init(_devConfig);
+	}

+	if (!_isDeviceInError)
+	{
+		_apiPort = API_DEFAULT_PORT;
 		_isRestoreOrigState = _devConfig[CONFIG_RESTORE_STATE].toBool(DEFAULT_IS_RESTORE_STATE);
 		_isSyncOverwrite = _devConfig[CONFIG_SYNC_OVERWRITE].toBool(DEFAULT_IS_SYNC_OVERWRITE);
 		_isBrightnessOverwrite = _devConfig[CONFIG_BRIGHTNESS_OVERWRITE].toBool(DEFAULT_IS_BRIGHTNESS_OVERWRITE);
@@ -99,57 +122,78 @@ bool LedDeviceWled::init(const QJsonObject &deviceConfig)
 		Debug(_log, "Overwrite Brightn.: %d", _isBrightnessOverwrite);
 		Debug(_log, "Set Brightness to : %d", _brightness);

-		//Set hostname as per configuration
-		QString hostName = deviceConfig[ CONFIG_ADDRESS ].toString();
-
-		//If host not configured the init fails
-		if ( hostName.isEmpty() )
-		{
-			this->setInError("No target hostname nor IP defined");
-			return false;
-		}
-		else
-		{
-			QStringList addressparts = QStringUtils::split(hostName,":", QStringUtils::SplitBehavior::SkipEmptyParts);
-			_hostname = addressparts[0];
-			if ( addressparts.size() > 1 )
-			{
-				_apiPort = addressparts[1].toInt();
-			}
-			else
-			{
-				_apiPort = API_DEFAULT_PORT;
-			}
-
-			if ( initRestAPI( _hostname, _apiPort ) )
-			{
-				// Update configuration with hostname without port
-				_devConfig["host"] = _hostname;
-				_devConfig["port"] = STREAM_DEFAULT_PORT;
-
-				isInitOK = ProviderUdp::init(_devConfig);
-				Debug(_log, "Hostname/IP  : %s", QSTRING_CSTR( _hostname ));
-				Debug(_log, "Port         : %d", _port);
-			}
-		}
+		isInitOK = true;
 	}
+
 	return isInitOK;
 }

-bool LedDeviceWled::initRestAPI(const QString &hostname, int port)
+bool LedDeviceWled::openRestAPI()
 {
-	bool isInitOK = false;
+	bool isInitOK {true};

 	if ( _restApi == nullptr )
 	{
-		_restApi = new ProviderRestApi(hostname, port);
-		_restApi->setBasePath( API_BASE_PATH );
+		_restApi = new ProviderRestApi(_address.toString(), _apiPort);
+		_restApi->setLogger(_log);

-		isInitOK = true;
+		_restApi->setBasePath( API_BASE_PATH );
 	}
+	else
+	{
+		_restApi->setHost(_address.toString());
+		_restApi->setPort(_apiPort);
+	}
+
 	return isInitOK;
 }

+int LedDeviceWled::open()
+{
+	int retval = -1;
+	_isDeviceReady = false;
+
+	if (NetUtils::resolveHostToAddress(_log, _hostName, _address, _apiPort))
+	{
+		if ( openRestAPI() )
+		{
+			if (_isStreamDDP)
+			{
+				if (LedDeviceUdpDdp::open() == 0)
+				{
+					// Everything is OK, device is ready
+					_isDeviceReady = true;
+					retval = 0;
+				}
+			}
+			else
+			{
+				if (LedDeviceUdpRaw::open() == 0)
+				{
+					// Everything is OK, device is ready
+					_isDeviceReady = true;
+					retval = 0;
+				}
+			}
+		}
+	}
+	return retval;
+}
+
+int LedDeviceWled::close()
+{
+	int retval = -1;
+	if (_isStreamDDP)
+	{
+		retval = LedDeviceUdpDdp::close();
+	}
+	else
+	{
+		retval = LedDeviceUdpRaw::close();
+	}
+	return retval;
+}
+
 QString LedDeviceWled::getOnOffRequest(bool isOn) const
 {
 	QString state = isOn ? STATE_VALUE_TRUE : STATE_VALUE_FALSE;
@@ -316,6 +360,16 @@ QJsonObject LedDeviceWled::discover(const QJsonObject& /*params*/)
 	devicesDiscovered.insert("ledDeviceType", _activeDeviceType );

 	QJsonArray deviceList;
+
+#ifdef ENABLE_MDNS
+	QString discoveryMethod("mDNS");
+	deviceList = MdnsBrowser::getInstance().getServicesDiscoveredJson(
+		MdnsServiceRegister::getServiceType(_activeDeviceType),
+		MdnsServiceRegister::getServiceNameFilter(_activeDeviceType),
+		DEFAULT_DISCOVER_TIMEOUT
+		);
+	devicesDiscovered.insert("discoveryMethod", discoveryMethod);
+#endif
 	devicesDiscovered.insert("devices", deviceList);
 	DebugIf(verbose, _log, "devicesDiscovered: [%s]", QString(QJsonDocument(devicesDiscovered).toJson(QJsonDocument::Compact)).toUtf8().constData() );

@@ -327,41 +381,45 @@ QJsonObject LedDeviceWled::getProperties(const QJsonObject& params)
 	DebugIf(verbose, _log, "params: [%s]", QString(QJsonDocument(params).toJson(QJsonDocument::Compact)).toUtf8().constData() );
 	QJsonObject properties;

-	QString hostName = params["host"].toString("");
+	_hostName = params[CONFIG_HOST].toString("");
+	_apiPort = API_DEFAULT_PORT;

-	if ( !hostName.isEmpty() )
+	Info(_log, "Get properties for %s, hostname (%s)", QSTRING_CSTR(_activeDeviceType), QSTRING_CSTR(_hostName) );
+
+	if (NetUtils::resolveHostToAddress(_log, _hostName, _address, _apiPort))
 	{
-		QString filter = params["filter"].toString("");
-
-		// Resolve hostname and port (or use default API port)
-		QStringList addressparts = QStringUtils::split(hostName,":", QStringUtils::SplitBehavior::SkipEmptyParts);
-		QString apiHost = addressparts[0];
-		int apiPort;
-
-		if ( addressparts.size() > 1)
+		if ( openRestAPI() )
 		{
-			apiPort = addressparts[1].toInt();
-		}
-		else
-		{
-			apiPort   = API_DEFAULT_PORT;
-		}
+			QString filter = params["filter"].toString("");
+			_restApi->setPath(filter);

-		initRestAPI(apiHost, apiPort);
-		_restApi->setPath(filter);
+			httpResponse response = _restApi->get();
+			if ( response.error() )
+			{
+				Warning (_log, "%s get properties failed with error: '%s'", QSTRING_CSTR(_activeDeviceType), QSTRING_CSTR(response.getErrorReason()));
+			}

-		httpResponse response = _restApi->get();
-		if ( response.error() )
-		{
-			Warning (_log, "%s get properties failed with error: '%s'", QSTRING_CSTR(_activeDeviceType), QSTRING_CSTR(response.getErrorReason()));
-		}
+			QJsonObject propertiesDetails = response.getBody().object();

-		QJsonObject propertiesDetails = response.getBody().object();
-		if (!propertiesDetails.isEmpty())
-		{
-			propertiesDetails.insert("maxLedCount", UDP_MAX_LED_NUM);
+			semver::version currentVersion {""};
+			if (currentVersion.setVersion(propertiesDetails.value("ver").toString().toStdString()))
+			{
+				semver::version ddpVersion{WLED_VERSION_DDP};
+				if (currentVersion < ddpVersion)
+				{
+					Warning(_log, "DDP streaming not supported by your WLED device version [%s], minimum version expected [%s]. Fall back to UDP-Streaming (%d LEDs max)", currentVersion.getVersion().c_str(), ddpVersion.getVersion().c_str(), UDP_MAX_LED_NUM);
+					if (!propertiesDetails.isEmpty())
+					{
+						propertiesDetails.insert("maxLedCount", UDP_MAX_LED_NUM);
+					}
+				}
+				else
+				{
+					Info(_log, "DDP streaming is supported by your WLED device version [%s]. No limitation in number of LEDs.", currentVersion.getVersion().c_str(), ddpVersion.getVersion().c_str());
+				}
+			}
+			properties.insert("properties", propertiesDetails);
 		}
-		properties.insert("properties", propertiesDetails);

 		DebugIf(verbose, _log, "properties: [%s]", QString(QJsonDocument(properties).toJson(QJsonDocument::Compact)).toUtf8().constData() );
 	}
@@ -372,41 +430,40 @@ void LedDeviceWled::identify(const QJsonObject& params)
 {
 	DebugIf(verbose, _log, "params: [%s]", QString(QJsonDocument(params).toJson(QJsonDocument::Compact)).toUtf8().constData());

-	QString hostName = params["host"].toString("");
+	_hostName = params[CONFIG_HOST].toString("");
+	_apiPort = API_DEFAULT_PORT;

-	if ( !hostName.isEmpty() )
+	Info(_log, "Identify %s, hostname (%s)", QSTRING_CSTR(_activeDeviceType), QSTRING_CSTR(_hostName) );
+
+	if (NetUtils::resolveHostToAddress(_log, _hostName, _address, _apiPort))
 	{
-		// Resolve hostname and port (or use default API port)
-		QStringList addressparts = QStringUtils::split(hostName,":", QStringUtils::SplitBehavior::SkipEmptyParts);
-		QString apiHost = addressparts[0];
-		int apiPort;
-
-		if ( addressparts.size() > 1)
+		if ( openRestAPI() )
 		{
-			apiPort = addressparts[1].toInt();
+			_isRestoreOrigState = true;
+			storeState();
+
+			QString request = getOnOffRequest(true) + "," + getLorRequest(1) + "," + getEffectRequest(25);
+			sendStateUpdateRequest(request);
+
+			wait(DEFAULT_IDENTIFY_TIME);
+
+			restoreState();
 		}
-		else
-		{
-			apiPort   = API_DEFAULT_PORT;
-		}
-
-		initRestAPI(apiHost, apiPort);
-
-		_isRestoreOrigState = true;
-		storeState();
-
-		QString request = getOnOffRequest(true) + "," + getLorRequest(1) + "," + getEffectRequest(25);
-		sendStateUpdateRequest(request);
-
-		wait(DEFAULT_IDENTIFY_TIME);
-
-		restoreState();
 	}
 }

 int LedDeviceWled::write(const std::vector<ColorRgb> &ledValues)
 {
-	const uint8_t * dataPtr = reinterpret_cast<const uint8_t *>(ledValues.data());
+	int rc {0};

-	return writeBytes( _ledRGBCount, dataPtr);
+	if (_isStreamDDP)
+	{
+		rc = LedDeviceUdpDdp::write(ledValues);
+	}
+	else
+	{
+		rc = LedDeviceUdpRaw::write(ledValues);
+	}
+
+	return rc;
 }