AtmoOrb Fix (#988)

* AtmoOrb UdpSocket-Bind Fix * Cleanup and update defaults (to work via PowerLan) * Cleanup and update defaults (to work via PowerLan) * AtmoOrb identification support, small updates * AtmoOrb discovery & identification support, fixes and stability updates * Small clean-ups * Type fix * Add missing include * Adalight - Update default config and levels * Update Atmoorb sketch * Yeelight - Update default value
2025-03-01 10:33:28 +00:00 · 2020-09-14 17:20:00 +02:00
parent 4aabe175cd
commit 7a685185f4
13 changed files with 898 additions and 105 deletions
--- a/libsrc/leddevice/LedDevice.cpp
+++ b/libsrc/leddevice/LedDevice.cpp
@@ -165,7 +165,10 @@ void LedDevice::startRefreshTimer()

 void LedDevice::stopRefreshTimer()
 {
-	_refreshTimer->stop();
+	if ( _refreshTimer != nullptr )
+	{
+		_refreshTimer->stop();
+	}
 }

 int LedDevice::updateLeds(const std::vector<ColorRgb>& ledValues)
--- a/libsrc/leddevice/dev_net/LedDeviceAtmoOrb.cpp
+++ b/libsrc/leddevice/dev_net/LedDeviceAtmoOrb.cpp
@@ -4,20 +4,30 @@

 // qt includes
 #include <QUdpSocket>
+#include <QNetworkInterface>
+#include <QUrl>
+#include <QHostInfo>

-const quint16 MULTICAST_GROUPL_DEFAULT_PORT = 49692;
-const int LEDS_DEFAULT_NUMBER = 24;
+#include <chrono>
+
+// Constants
+namespace {
+
+const QString MULTICAST_GROUP_DEFAULT_ADDRESS = "239.255.255.250";
+const quint16 MULTICAST_GROUP_DEFAULT_PORT = 49692;
+
+constexpr std::chrono::milliseconds DEFAULT_DISCOVERY_TIMEOUT{2000};
+
+} //End of constants

 LedDeviceAtmoOrb::LedDeviceAtmoOrb(const QJsonObject &deviceConfig)
 	: LedDevice(deviceConfig)
 	  , _udpSocket (nullptr)
-	  , _multiCastGroupPort (MULTICAST_GROUPL_DEFAULT_PORT)
+	  , _multicastGroup(MULTICAST_GROUP_DEFAULT_ADDRESS)
+	  , _multiCastGroupPort (MULTICAST_GROUP_DEFAULT_PORT)
 	  , _joinedMulticastgroup (false)
 	  , _useOrbSmoothing (false)
-	  , _transitiontime (0)
 	  , _skipSmoothingDiff (0)
-	  , _numLeds (LEDS_DEFAULT_NUMBER)
-
 {
 }

@@ -38,14 +48,24 @@ bool LedDeviceAtmoOrb::init(const QJsonObject &deviceConfig)
 	if ( LedDevice::init(deviceConfig) )
 	{

-		_multicastGroup     = deviceConfig["output"].toString().toStdString().c_str();
+		_multicastGroup     = deviceConfig["output"].toString(MULTICAST_GROUP_DEFAULT_ADDRESS);
+		_multiCastGroupPort = static_cast<quint16>(deviceConfig["port"].toInt(MULTICAST_GROUP_DEFAULT_PORT));
 		_useOrbSmoothing    = deviceConfig["useOrbSmoothing"].toBool(false);
-		_transitiontime     = deviceConfig["transitiontime"].toInt(0);
 		_skipSmoothingDiff  = deviceConfig["skipSmoothingDiff"].toInt(0);
-		_multiCastGroupPort = static_cast<quint16>(deviceConfig["port"].toInt(MULTICAST_GROUPL_DEFAULT_PORT));
-		_numLeds            = deviceConfig["numLeds"].toInt(LEDS_DEFAULT_NUMBER);
-
 		QStringList orbIds = QStringUtils::split(deviceConfig["orbIds"].toString().simplified().remove(" "),",", QStringUtils::SplitBehavior::SkipEmptyParts);
+
+		Debug(_log, "DeviceType        : %s", QSTRING_CSTR( this->getActiveDeviceType() ));
+		Debug(_log, "LedCount          : %u", this->getLedCount());
+		Debug(_log, "ColorOrder        : %s", QSTRING_CSTR( this->getColorOrder() ));
+		Debug(_log, "RefreshTime       : %d", _refreshTimerInterval_ms);
+		Debug(_log, "LatchTime         : %d", this->getLatchTime());
+
+		Debug(_log, "MulticastGroup    : %s", QSTRING_CSTR(_multicastGroup));
+		Debug(_log, "MulticastGroupPort: %d", _multiCastGroupPort);
+		Debug(_log, "Orb ID list       : %s", QSTRING_CSTR(deviceConfig["orbIds"].toString()));
+		Debug(_log, "Use Orb Smoothing : %d", _useOrbSmoothing);
+		Debug(_log, "Skip SmoothingDiff: %d", _skipSmoothingDiff);
+
 		_orbIds.clear();

 		for (auto & id_str : orbIds)
@@ -69,6 +89,9 @@ bool LedDeviceAtmoOrb::init(const QJsonObject &deviceConfig)
 			}
 		}

+		uint numberOrbs = _orbIds.size();
+		uint configuredLedCount = this->getLedCount();
+
 		if ( _orbIds.empty() )
 		{
 			this->setInError("No valid OrbIds found!");
@@ -76,8 +99,23 @@ bool LedDeviceAtmoOrb::init(const QJsonObject &deviceConfig)
 		}
 		else
 		{
-			_udpSocket = new QUdpSocket(this);
-			isInitOK = true;
+			if ( numberOrbs < configuredLedCount )
+			{
+				QString errorReason = QString("Not enough Orbs [%1] for configured LEDs [%2] found!")
+										  .arg(numberOrbs)
+										  .arg(configuredLedCount);
+				this->setInError(errorReason);
+				isInitOK = false;
+			}
+			else
+			{
+				if ( numberOrbs > configuredLedCount )
+				{
+					Info(_log, "%s: More Orbs [%u] than configured LEDs [%u].", QSTRING_CSTR(this->getActiveDeviceType()), numberOrbs, configuredLedCount );
+				}
+
+				isInitOK = true;
+			}
 		}
 	}
 	return isInitOK;
@@ -88,30 +126,39 @@ int LedDeviceAtmoOrb::open()
 	int retval = -1;
 	_isDeviceReady = false;

+	if ( _udpSocket == nullptr )
+	{
+		_udpSocket = new QUdpSocket();
+	}
+
 	// Try to bind the UDP-Socket
 	if ( _udpSocket != nullptr )
 	{
-		_groupAddress = QHostAddress(_multicastGroup);
-		if ( !_udpSocket->bind(QHostAddress::AnyIPv4, _multiCastGroupPort, QUdpSocket::ShareAddress | QUdpSocket::ReuseAddressHint) )
+		if ( _udpSocket->state() != QAbstractSocket::BoundState )
 		{
-			QString errortext = QString ("(%1) %2, MulticastGroup: (%3)").arg(_udpSocket->error()).arg(_udpSocket->errorString(), _multicastGroup);
-			this->setInError( errortext );
-		}
-		else
-		{
-			_joinedMulticastgroup = _udpSocket->joinMulticastGroup(_groupAddress);
-			if ( !_joinedMulticastgroup )
+			if ( !_udpSocket->bind(QHostAddress(QHostAddress::AnyIPv4), 0 ) )
 			{
-				QString errortext = QString ("(%1) %2, MulticastGroup: (%3)").arg(_udpSocket->error()).arg(_udpSocket->errorString(), _multicastGroup);
+				QString errortext = QString ("Socket bind failed: (%1) %2, MulticastGroup: (%3)").arg(_udpSocket->error()).arg(_udpSocket->errorString(), _multicastGroup);
 				this->setInError( errortext );
 			}
 			else
 			{
-				// Everything is OK, device is ready
-				_isDeviceReady = true;
-				retval = 0;
+				_groupAddress = QHostAddress(_multicastGroup);
+				_joinedMulticastgroup = _udpSocket->joinMulticastGroup(_groupAddress);
+				if ( !_joinedMulticastgroup )
+				{
+					QString errortext = QString ("Joining Multicastgroup failed: (%1) %2, MulticastGroup: (%3)").arg(_udpSocket->error()).arg(_udpSocket->errorString(), _multicastGroup);
+					this->setInError( errortext );
+				}
 			}
 		}
+
+		if ( ! _isDeviceInError )
+		{
+			// Everything is OK, device is ready
+			_isDeviceReady = true;
+			retval = 0;
+		}
 	}
 	return retval;
 }
@@ -123,6 +170,11 @@ int LedDeviceAtmoOrb::close()

 	if ( _udpSocket != nullptr )
 	{
+		if ( _udpSocket->state() == QAbstractSocket::BoundState )
+		{
+			_udpSocket->leaveMulticastGroup(_groupAddress);
+		}
+
 		// Test, if device requires closing
 		if ( _udpSocket->isOpen() )
 		{
@@ -155,12 +207,17 @@ int LedDeviceAtmoOrb::write(const std::vector <ColorRgb> &ledValues)
 		commandType = 2;
 	}

-	// Iterate through colors and set Orb color
-	// Start off with idx 1 as 0 is reserved for controlling all orbs at once
-	int idx = 1;
-
-	for (const ColorRgb &color : ledValues)
+	ColorRgb color;
+	for (int idx = 0; idx < _orbIds.size(); idx++ )
 	{
+		if ( idx < static_cast<int>(ledValues.size()) )
+		{
+			color = ledValues[idx];
+		}
+		else
+		{
+			color = ColorRgb::BLACK;
+		}
 		// Retrieve last send colors
 		int lastRed = lastColorRedMap[idx];
 		int lastGreen = lastColorGreenMap[idx];
@@ -171,33 +228,16 @@ int LedDeviceAtmoOrb::write(const std::vector <ColorRgb> &ledValues)
 				abs(color.green - lastGreen) >= _skipSmoothingDiff))
 		{
 			// Skip Orb smoothing when using  (command type 4)
-			for (int i = 0; i < _orbIds.size(); i++)
-			{
-				if (_orbIds[i] == idx)
-				{
-					setColor(idx, color, 4);
-				}
-			}
-		}
-		else
-		{
-			// Send color
-			for (int i = 0; i < _orbIds.size(); i++)
-			{
-				if (_orbIds[i] == idx)
-				{
-					setColor(idx, color, commandType);
-				}
-			}
+			commandType = 4;
 		}

+		// Send color
+		setColor(_orbIds[idx], color, commandType);
+
 		// Store last colors send for light id
 		lastColorRedMap[idx]   = color.red;
 		lastColorGreenMap[idx] = color.green;
 		lastColorBlueMap[idx]  = color.blue;
-
-		// Next light id.
-		idx++;
 	}

 	return 0;
@@ -227,12 +267,117 @@ void LedDeviceAtmoOrb::setColor(int orbId, const ColorRgb &color, int commandTyp
 	bytes[6] = static_cast<char>(color.green);
 	bytes[7] = static_cast<char>(color.blue);

-	//std::cout << "Orb [" << orbId << "] Cmd [" << bytes.toHex(':').toStdString() <<"]"<< std::endl;
-
 	sendCommand(bytes);
 }

 void LedDeviceAtmoOrb::sendCommand(const QByteArray &bytes)
 {
+	//Debug ( _log, "command: [%s] -> %s:%u", QSTRING_CSTR( QString(bytes.toHex())), QSTRING_CSTR(_groupAddress.toString()), _multiCastGroupPort );
 	_udpSocket->writeDatagram(bytes.data(), bytes.size(), _groupAddress, _multiCastGroupPort);
 }
+
+QJsonObject LedDeviceAtmoOrb::discover()
+{
+	QJsonObject devicesDiscovered;
+	devicesDiscovered.insert("ledDeviceType", _activeDeviceType );
+
+	QJsonArray deviceList;
+
+	if ( open() == 0 )
+	{
+		Debug ( _log, "Send discovery requests to all AtmoOrbs" );
+		setColor(0, ColorRgb::BLACK, 8);
+
+		if ( _udpSocket->waitForReadyRead(DEFAULT_DISCOVERY_TIMEOUT.count()) )
+		{
+			while (_udpSocket->waitForReadyRead(500))
+			{
+				QByteArray datagram;
+
+				while (_udpSocket->hasPendingDatagrams())
+				{
+					datagram.resize(_udpSocket->pendingDatagramSize());
+					QHostAddress senderIP;
+					quint16 senderPort;
+
+					_udpSocket->readDatagram(datagram.data(), datagram.size(), &senderIP, &senderPort);
+
+					if ( datagram.size() == 1 )
+					{
+						unsigned char orbId = datagram[0];
+						if ( orbId > 0 )
+						{
+							Debug(_log, "Orb ID (%d) discovered at [%s]", orbId, QSTRING_CSTR(senderIP.toString()));
+							_services.insert(orbId, senderIP);
+						}
+					}
+				}
+			}
+		}
+
+		close();
+	}
+
+	QMap<int, QHostAddress>::iterator i;
+	for (i = _services.begin(); i != _services.end(); ++i)
+	{
+		QJsonObject obj;
+
+		obj.insert("id", i.key());
+		obj.insert("ip", i.value().toString());
+
+		QHostInfo hostInfo = QHostInfo::fromName(i.value().toString());
+		if (hostInfo.error() == QHostInfo::NoError )
+		{
+			QString hostname = hostInfo.hostName();
+			//Seems that for Windows no local domain name is resolved
+			if (!hostInfo.localDomainName().isEmpty() )
+			{
+				obj.insert("hostname", hostname.remove("."+hostInfo.localDomainName()));
+				obj.insert("domain", hostInfo.localDomainName());
+			}
+			else
+			{
+				int domainPos = hostname.indexOf('.');
+				obj.insert("hostname", hostname.left(domainPos));
+				obj.insert("domain", hostname.mid(domainPos+1));
+			}
+		}
+
+		deviceList  << obj;
+	}
+
+	devicesDiscovered.insert("devices", deviceList);
+	Debug(_log, "devicesDiscovered: [%s]", QString(QJsonDocument(devicesDiscovered).toJson(QJsonDocument::Compact)).toUtf8().constData() );
+
+	return devicesDiscovered;
+}
+
+void LedDeviceAtmoOrb::identify(const QJsonObject& params)
+{
+	//Debug(_log, "params: [%s]", QString(QJsonDocument(params).toJson(QJsonDocument::Compact)).toUtf8().constData());
+
+	int orbId = 0;
+	if ( params["id"].isString() )
+	{
+		orbId = params["id"].toString().toInt();
+	}
+	else
+	{
+		orbId = params["id"].toInt();
+	}
+
+	if ( orbId >0 && orbId < 256 )
+	{
+		Debug (_log, "Orb ID [%d]", orbId);
+		if ( open() == 0 )
+		{
+			setColor(orbId, ColorRgb::BLACK, 9);
+			close();
+		}
+	}
+	else
+	{
+		Warning(_log, "Identification of Orb with ID='%d' skipped. ID must be in range 1-255", orbId);
+	}
+}
--- a/libsrc/leddevice/dev_net/LedDeviceAtmoOrb.h
+++ b/libsrc/leddevice/dev_net/LedDeviceAtmoOrb.h
@@ -11,13 +11,10 @@

 class QUdpSocket;

-/**
- * Implementation for the AtmoOrb
- *
- * To use set the device to "atmoorb".
- *
- * @author RickDB (github)
- */
+///
+/// Implementation of the LedDevice interface for sending to
+/// AtmoOrb devices via network
+///
 class LedDeviceAtmoOrb : public LedDevice
 {
 	Q_OBJECT
@@ -43,6 +40,27 @@ public:
 	///
 	static LedDevice* construct(const QJsonObject &deviceConfig);

+	///
+	/// @brief Discover AtmoOrb devices available (for configuration).
+	///
+	/// @return A JSON structure holding a list of devices found
+	///
+	virtual QJsonObject discover() override;
+
+	///
+	/// @brief Send an update to the AtmoOrb device to identify it.
+	///
+	/// Following parameters are required
+	/// @code
+	/// {
+	///     "orbId"  : "orb identifier in the range of (1-255)",
+	/// }
+	///@endcode
+	///
+	/// @param[in] params Parameters to address device
+	///
+	virtual void identify(const QJsonObject& params) override;
+
 protected:

 	///
@@ -111,15 +129,9 @@ private:
 	/// use Orbs own (external) smoothing algorithm
 	bool _useOrbSmoothing;

-	/// Transition time between colors (not implemented)
-	int _transitiontime;
-
 	// Maximum allowed color difference, will skip Orb (external) smoothing once reached
 	int _skipSmoothingDiff;

-	/// Number of leds in Orb, used to determine buffer size
-	int _numLeds;
-
 	/// Array of the orb ids.
 	QVector<int> _orbIds;

@@ -127,6 +139,8 @@ private:
 	QMap<int, int> lastColorRedMap;
 	QMap<int, int> lastColorGreenMap;
 	QMap<int, int> lastColorBlueMap;
+
+	QMultiMap<int, QHostAddress> _services;
 };

 #endif // LEDEVICEATMOORB_H
--- a/libsrc/leddevice/dev_net/LedDeviceNanoleaf.cpp
+++ b/libsrc/leddevice/dev_net/LedDeviceNanoleaf.cpp
@@ -319,7 +319,7 @@ bool LedDeviceNanoleaf::initLedsConfiguration()
 		{
 			if ( _panelLedCount > this->getLedCount() )
 			{
-				Info(_log, "Nanoleaf: More panels [%u] than configured LEDs [%u].", _panelLedCount, configuredLedCount );
+				Info(_log, "%s: More panels [%u] than configured LEDs [%u].", QSTRING_CSTR(this->getActiveDeviceType()), _panelLedCount, configuredLedCount );
 			}

 			// Check, if start position + number of configured LEDs is greater than number of panels available
@@ -449,9 +449,7 @@ QJsonObject LedDeviceNanoleaf::getProperties(const QJsonObject& params)
 void LedDeviceNanoleaf::identify(const QJsonObject& params)
 {
 	Debug(_log, "params: [%s]", QString(QJsonDocument(params).toJson(QJsonDocument::Compact)).toUtf8().constData() );
-	QJsonObject properties;

-	// Get Nanoleaf device properties
 	QString host = params["host"].toString("");
 	if ( !host.isEmpty() )
 	{
--- a/libsrc/leddevice/dev_net/LedDeviceWled.cpp
+++ b/libsrc/leddevice/dev_net/LedDeviceWled.cpp
@@ -235,9 +235,7 @@ void LedDeviceWled::identify(const QJsonObject& /*params*/)
 {
 #if 0
 	Debug(_log, "params: [%s]", QString(QJsonDocument(params).toJson(QJsonDocument::Compact)).toUtf8().constData());
-	QJsonObject properties;

-	// Get Nanoleaf device properties
 	QString host = params["host"].toString("");
 	if ( !host.isEmpty() )
 	{
--- a/libsrc/leddevice/dev_net/LedDeviceYeelight.cpp
+++ b/libsrc/leddevice/dev_net/LedDeviceYeelight.cpp
@@ -1357,7 +1357,7 @@ QJsonObject LedDeviceYeelight::discover()

 	QJsonArray deviceList;

-	// Discover WLED Devices
+	// Discover Yeelight Devices
 	SSDPDiscover discover;
 	discover.setPort(SSDP_PORT);
 	discover.skipDuplicateKeys(true);
--- a/libsrc/leddevice/schemas/schema-adalight.json
+++ b/libsrc/leddevice/schemas/schema-adalight.json
@@ -5,26 +5,29 @@
 		"output": {
 			"type": "string",
 			"title":"edt_dev_spec_outputPath_title",
-			"default":"ttyACM0",
+			"default":"auto",
 			"propertyOrder" : 1
 		},
 		"rate": {
 			"type": "integer",
 			"title":"edt_dev_spec_baudrate_title",
-			"default": 1000000,
+			"default": 115200,
+			"access" : "advanced",
 			"propertyOrder" : 2
 		},
 		"delayAfterConnect": {
 			"type": "integer",
 			"title":"edt_dev_spec_delayAfterConnect_title",
-			"default": 1500,
+			"default": 0,
 			"append" : "ms",
+			"access" : "expert",
 			"propertyOrder" : 3
 		},
 		"lightberry_apa102_mode": {
 			"type": "boolean",
 			"title":"edt_dev_spec_LBap102Mode_title",
 			"default": false,
+			"access" : "advanced",
 			"propertyOrder" : 4
 		},
 		"latchTime": {
--- a/libsrc/leddevice/schemas/schema-atmoorb.json
+++ b/libsrc/leddevice/schemas/schema-atmoorb.json
@@ -2,22 +2,24 @@
 	"type":"object",
 	"required":true,
 	"properties":{
-		"output": {
-			"type": "string",
-			"title":"edt_dev_spec_multicastGroup_title",
-			"default" : "239.15.18.2",
-			"propertyOrder" : 1
-		},
 		"orbIds": {
 			"type": "string",
 			"title":"edt_dev_spec_orbIds_title",
-			"default": "1",
+			"default": "",
+			"propertyOrder" : 1
+		},
+		"useOrbSmoothing": {
+			"type": "boolean",
+			"title":"edt_dev_spec_useOrbSmoothing_title",
+			"default": true,
+			"access" : "advanced",
 			"propertyOrder" : 2
 		},
-		"numLeds": {
-			"type": "integer",
-			"title":"edt_dev_spec_numberOfLeds_title",
-			"default": 24,
+		"output": {
+			"type": "string",
+			"title":"edt_dev_spec_multicastGroup_title",
+			"default" : "239.255.255.250",
+			"access" : "expert",
 			"propertyOrder" : 3
 		},
 		"port": {
@@ -25,25 +27,20 @@
 			"title":"edt_dev_spec_port_title",
 			"minimum" : 0,
 			"maximum" : 65535,
-			"default": 49.692,
+			"default": 49692,
+			"access" : "expert",
 			"propertyOrder" : 4
-		},
-		"useOrbSmoothing": {
-			"type": "boolean",
-			"title":"edt_dev_spec_useOrbSmoothing_title",
-			"default": true,
-			"propertyOrder" : 5
-		},
+		},		
 		"latchTime": {
 			"type": "integer",
 			"title":"edt_dev_spec_latchtime_title",
-			"default": 0,
+			"default": 30,
 			"append" : "edt_append_ms",
 			"minimum": 0,
 			"maximum": 1000,
 			"access" : "expert",
-			"propertyOrder" : 6
-		}	
+			"propertyOrder" : 5
+		}
 	},
 	"additionalProperties": true
 }
--- a/libsrc/leddevice/schemas/schema-yeelight.json
+++ b/libsrc/leddevice/schemas/schema-yeelight.json
@@ -47,9 +47,9 @@
 			"type": "integer",
 			"title":"edt_dev_spec_transistionTimeExtra_title",
 			"default" : 0,
-			"step": 10,
+			"step": 100,
 			"minimum" : 0,
-			"maximum" : 3000,
+			"maximum" : 8000,
 			"append" : "ms",
 			"access" : "advanced",
 			"propertyOrder" : 4