Disentangle LedDevice/LinearColorSmoothing, Bug Fixes & Test support (#654)

* Handle Exceptions in main & Pythoninit * Have SSDPDiscover generic again * Have SSDPDiscover generic again * Change Info- to Debug logs as technical service messages * Nanoleaf - When switched on, ensure UDP mode * Include SQL Database in Cross-Compile instructions * Fix Clazy (QT code checker) and clang Warnings * Stop LedDevice:write for disabled device * Nanoleaf: Fix uint printfs * NanoLeaf: Fix indents to tabs * NanoLeaf - Add debug verbosity switches * Device switchability support, FileDevice with timestamp support * Nanoleaf Light Panels now support External Control V2 * Enhance LedDeviceFile by Timestamp + fix readyness * Stop color stream, if LedDevice disabled * Nanoleaf - remove switchability * Fix MultiColorAdjustment, if led-range is greater lednum * Fix logging * LedFileDevice/LedDevice - add testing support * New "Led Test" effect * LedDeviceFile - Add chrono include + Allow Led rewrites for testing * Stabilize Effects for LedDevices where latchtime = 0 * Update LedDeviceFile, allow latchtime = 0 * Distangle LinearColorSmoothing and LEDDevice, Fix Effect configuration updates * Updates LedDeviceFile - Initialize via Open * Updates LedDeviceNanoleaf - Initialize via Open, Remove throwing exceptions * Updates ProviderUDP - Remove throwing exceptions * Framebuffer - Use precise timer * TestSpi - Align to LedDevice updates * Pretty Print CrossCompileHowTo as markdown-file * Ensure that output is only written when LedDevice is ready * Align APA102 Device to new device staging * Logger - Remove clang warnings on extra semicolon * Devices SPI - Align to Device stages and methods * Fix cppcheck and clang findings * Add Code-Template for new Devices * Align devices to stages and methods, clean-up some code * Allow to reopen LedDevice without restart * Revert change "Remove Connect (PriorityMuxer::visiblePriorityChanged -> Hyperion::update) due to double writes" * Remove visiblePriorityChanged from LedDevice to decouple LedDevice from hyperion logic * Expose LedDevice getLedCount and align signedness
2025-03-01 10:33:28 +00:00 · 2020-02-10 15:21:58 +01:00
parent 1aba51e85c
commit ed5455458b
107 changed files with 2980 additions and 1551 deletions
--- a/libsrc/leddevice/dev_other/LedDeviceFile.cpp
+++ b/libsrc/leddevice/dev_other/LedDeviceFile.cpp
@@ -7,7 +7,9 @@
 LedDeviceFile::LedDeviceFile(const QJsonObject &deviceConfig)
 	: LedDevice()
 {
-	_deviceReady = init(deviceConfig);
+	_devConfig = deviceConfig;
+	_deviceReady = false;
+	_printTimeStamp = false;
 }

 LedDeviceFile::~LedDeviceFile()
@@ -21,39 +23,83 @@ LedDevice* LedDeviceFile::construct(const QJsonObject &deviceConfig)

 bool LedDeviceFile::init(const QJsonObject &deviceConfig)
 {
-	LedDevice::init(deviceConfig);
-	_refresh_timer_interval = 0;
+	bool initOK = LedDevice::init(deviceConfig);
+
 	_fileName = deviceConfig["output"].toString("/dev/null");
 	_printTimeStamp = deviceConfig["printTimeStamp"].toBool(false);

-	return true;
+	return initOK;
 }

 int LedDeviceFile::open()
 {
-	if ( _ofs.is_open() )
+	int retval = -1;
+	QString errortext;
+	_deviceReady = false;
+
+	if ( init(_devConfig) )
+	{
+		if ( _ofs.is_open() )
+		{
+			_ofs.close();
+		}
+
+		_ofs.open( QSTRING_CSTR(_fileName));
+		if ( _ofs.fail() )
+		{
+			errortext = QString ("Failed to open file (%1). Error message: %2").arg(_fileName, strerror(errno));
+		}
+		else
+		{
+			_deviceReady = true;
+			setEnable(true);
+			retval = 0;
+		}
+
+		if ( retval < 0 )
+		{
+			this->setInError( errortext );
+		}
+	}
+	return retval;
+}
+
+void LedDeviceFile::close()
+{
+	LedDevice::close();
+
+	// LedDevice specific closing activites
+	if ( _ofs )
 	{
 		_ofs.close();
+		if ( _ofs.fail() )
+		{
+			Error( _log, "Failed to close device (%s). Error message: %s", QSTRING_CSTR(_fileName), strerror(errno) );
+		}
 	}
-	_ofs.open( QSTRING_CSTR(_fileName) );
-	return 0;
 }

 int LedDeviceFile::write(const std::vector<ColorRgb> & ledValues)
 {
+	//printLedValues (ledValues);
 	if ( _printTimeStamp )
 	{
 		// get a precise timestamp as a string
 		const auto now = std::chrono::system_clock::now();
 		const auto nowAsTimeT = std::chrono::system_clock::to_time_t(now);
 		const auto nowMs = std::chrono::duration_cast<std::chrono::milliseconds>(
-		now.time_since_epoch()) % 1000;
+							   now.time_since_epoch()) % 1000;
+
+		const auto elapsedTimeMs = std::chrono::duration_cast<std::chrono::milliseconds>(now - lastWriteTime);

 		_ofs
 			<< std::put_time(std::localtime(&nowAsTimeT), "%Y-%m-%d %T")
-			<< '.' << std::setfill('0') << std::setw(3) << nowMs.count();
+			<< '.' << std::setfill('0') << std::setw(3) << nowMs.count()
+			<< " | +" << std::setfill('0') << std::setw(4) << elapsedTimeMs.count();

+		lastWriteTime = now;
 	}
+
 	_ofs << " [";
 	for (const ColorRgb& color : ledValues)
 	{
--- a/libsrc/leddevice/dev_other/LedDeviceFile.h
+++ b/libsrc/leddevice/dev_other/LedDeviceFile.h
@@ -2,6 +2,7 @@

 // STL includes
 #include <fstream>
+#include <chrono>

 // Leddevice includes
 #include <leddevice/LedDevice.h>
@@ -18,12 +19,12 @@ public:
 	///
 	/// @param deviceConfig json device config
 	///
-	LedDeviceFile(const QJsonObject &deviceConfig);
+	explicit LedDeviceFile(const QJsonObject &deviceConfig);

 	///
 	/// Destructor of this test-device
 	///
-	virtual ~LedDeviceFile();
+	virtual ~LedDeviceFile() override;

 	/// constructs leddevice
 	static LedDevice* construct(const QJsonObject &deviceConfig);
@@ -33,16 +34,23 @@ public:
 	///
 	/// @param deviceConfig the json device config
 	/// @return true if success
-	virtual bool init(const QJsonObject &deviceConfig);
+	virtual bool init(const QJsonObject &deviceConfig) override;
+
+public slots:
+	///
+	/// Closes the output device.
+	/// Includes switching-off the device and stopping refreshes
+	///
+	virtual void close() override;
 	
 protected:
 	///
-	/// Opens and configures the output file
+	/// Opens and initiatialises the output device
 	///
-	/// @return Zero on succes else negative
+	/// @return Zero on succes (i.e. device is ready and enabled) else negative
 	///
-	///
-	virtual int open();
+	virtual int open() override;
+
 	///
 	/// Writes the given led-color values to the output stream
 	///
@@ -50,7 +58,7 @@ protected:
 	///
 	/// @return Zero on success else negative
 	///
-	virtual int write(const std::vector<ColorRgb> & ledValues);
+	virtual int write(const std::vector<ColorRgb> & ledValues) override;

 	/// The outputstream
 	std::ofstream _ofs;
@@ -60,4 +68,7 @@ private:
 	QString _fileName;
 	/// Timestamp for the output record
 	bool _printTimeStamp;
+	/// Last write/output timestamp
+	std::chrono::system_clock::time_point lastWriteTime = std::chrono::system_clock::now();
+
 };
--- a/libsrc/leddevice/dev_other/LedDevicePiBlaster.cpp
+++ b/libsrc/leddevice/dev_other/LedDevicePiBlaster.cpp
@@ -12,12 +12,15 @@
 LedDevicePiBlaster::LedDevicePiBlaster(const QJsonObject &deviceConfig)
 	: _fid(nullptr)
 {
+	_devConfig = deviceConfig;
+	_deviceReady = false;
+
 	signal(SIGPIPE,  SIG_IGN);

-// initialise the mapping tables
-// -1 is invalid
-// z is also meaningless
-// { "gpio" : 4, "ledindex" : 0, "ledcolor" : "r" },
+	// initialise the mapping tables
+	// -1 is invalid
+	// z is also meaningless
+	// { "gpio" : 4, "ledindex" : 0, "ledcolor" : "r" },
 	#define TABLE_SZ sizeof(_gpio_to_led)/sizeof(_gpio_to_led[0])

 	for (unsigned i=0; i <  TABLE_SZ; i++ )
@@ -25,51 +28,48 @@ LedDevicePiBlaster::LedDevicePiBlaster(const QJsonObject &deviceConfig)
 		_gpio_to_led[i] = -1;
 		_gpio_to_color[i] = 'z';
 	}
-
-	_deviceReady = init(deviceConfig);
 }

 LedDevicePiBlaster::~LedDevicePiBlaster()
 {
-	// Close the device (if it is opened)
-	if (_fid != nullptr)
-	{
-		fclose(_fid);
-		_fid = nullptr;
-	}
+
 }


 bool LedDevicePiBlaster::init(const QJsonObject &deviceConfig)
 {
-	LedDevice::init(deviceConfig);
+	bool isInitOK = LedDevice::init(deviceConfig);

 	_deviceName    = deviceConfig["output"].toString("/dev/pi-blaster");
-	QJsonArray gpioMapping = deviceConfig["gpiomap"].toArray();

-	if (gpioMapping.isEmpty())
+	if ( isInitOK )
 	{
-		throw std::runtime_error("Piblaster: no gpiomap defined.");
-	}
+		QJsonArray gpioMapping = deviceConfig["gpiomap"].toArray();

-	// walk through the json config and populate the mapping tables
-	for(QJsonArray::const_iterator gpioArray = gpioMapping.begin(); gpioArray != gpioMapping.end(); ++gpioArray)
-	{
-		const QJsonObject value = (*gpioArray).toObject();
-		const int gpio = value["gpio"].toInt(-1);
-		const int ledindex = value["ledindex"].toInt(-1);
-		const std::string ledcolor = value["ledcolor"].toString("z").toStdString();
+		if (gpioMapping.isEmpty())
+		{
+			this->setInError("PiBlaster: no gpiomap defined.");
+			return false;
+		}

-		// ignore missing/invalid settings
-		if ( (gpio >= 0) && (gpio < signed(TABLE_SZ)) && (ledindex >= 0) ){
-			_gpio_to_led[gpio] = ledindex;
-			_gpio_to_color[gpio] = ledcolor[0]; // 1st char of string
-		} else {
-			Warning( _log, "IGNORING gpio %d ledindex %d color %c", gpio,ledindex, ledcolor[0]);
+		// walk through the json config and populate the mapping tables
+		for(QJsonArray::const_iterator gpioArray = gpioMapping.begin(); gpioArray != gpioMapping.end(); ++gpioArray)
+		{
+			const QJsonObject value = (*gpioArray).toObject();
+			const int gpio = value["gpio"].toInt(-1);
+			const int ledindex = value["ledindex"].toInt(-1);
+			const std::string ledcolor = value["ledcolor"].toString("z").toStdString();
+
+			// ignore missing/invalid settings
+			if ( (gpio >= 0) && (gpio < signed(TABLE_SZ)) && (ledindex >= 0) ){
+				_gpio_to_led[gpio] = ledindex;
+				_gpio_to_color[gpio] = ledcolor[0]; // 1st char of string
+			} else {
+				Warning( _log, "IGNORING gpio %d ledindex %d color %c", gpio,ledindex, ledcolor[0]);
+			}
 		}
 	}
-
-	return true;
+	return isInitOK;
 }

 LedDevice* LedDevicePiBlaster::construct(const QJsonObject &deviceConfig)
@@ -79,30 +79,61 @@ LedDevice* LedDevicePiBlaster::construct(const QJsonObject &deviceConfig)

 int LedDevicePiBlaster::open()
 {
+	int retval = -1;
+	QString errortext;
+	_deviceReady = false;
+
+	if ( init(_devConfig) )
+	{
+		if (_fid != nullptr)
+		{
+			// The file pointer is already open
+			errortext = QString ("Device (%1) is already open.").arg(_deviceName);
+		}
+		else
+		{
+			if (!QFile::exists(_deviceName))
+			{
+				errortext = QString ("The device (%1) does not yet exist.").arg(_deviceName);
+
+			}
+			else
+			{
+				_fid = fopen(QSTRING_CSTR(_deviceName), "w");
+				if (_fid == nullptr)
+				{
+					errortext = QString ("Failed to open device (%1). Error message: %2").arg(_deviceName, strerror(errno));
+				}
+				else
+				{
+					Info( _log, "Connected to device(%s)", QSTRING_CSTR(_deviceName));
+					retval = 0;
+					setEnable(true);
+				}
+			}
+		}
+
+		if ( retval < 0 )
+		{
+			this->setInError( errortext );
+
+		}
+	}
+	return retval;
+}
+
+void LedDevicePiBlaster::close()
+{
+	LedDevice::close();
+
+	// LedDevice specific closing activites
+	// Close the device (if it is opened)
 	if (_fid != nullptr)
 	{
-		// The file pointer is already open
-		Error( _log, "Device (%s) is already open.", QSTRING_CSTR(_deviceName) );
-		return -1;
-	}
+		fclose(_fid);
+		_fid = nullptr;
+	}}

-	if (!QFile::exists(_deviceName))
-	{
-		Error( _log, "The device (%s) does not yet exist.",QSTRING_CSTR(_deviceName) );
-		return -1;
-	}
-
-	_fid = fopen(QSTRING_CSTR(_deviceName), "w");
-	if (_fid == nullptr)
-	{
-		Error( _log, "Failed to open device (%s). Error message: %s", QSTRING_CSTR(_deviceName),  strerror(errno) );
-		return -1;
-	}
-
-	Info( _log, "Connected to device(%s)", QSTRING_CSTR(_deviceName));
-
-	return 0;
-}

 int LedDevicePiBlaster::write(const std::vector<ColorRgb> & ledValues)
 {
@@ -112,11 +143,10 @@ int LedDevicePiBlaster::write(const std::vector<ColorRgb> & ledValues)
 		return -1;
 	}

-	int valueIdx = -1;
 	for (unsigned int i=0; i < TABLE_SZ; i++ )
 	{
-		valueIdx = _gpio_to_led[ i ];
-		if ( (valueIdx >= 0) && (valueIdx < _ledCount) ) 
+		int valueIdx = _gpio_to_led[ i ];
+		if ( (valueIdx >= 0) && (valueIdx < static_cast<int>( _ledCount)) )
 		{
 			double pwmDutyCycle = 0.0;
 			switch (_gpio_to_color[ i ]) 
--- a/libsrc/leddevice/dev_other/LedDevicePiBlaster.h
+++ b/libsrc/leddevice/dev_other/LedDevicePiBlaster.h
@@ -15,27 +15,35 @@ public:
 	///
 	/// @param deviceConfig json device config
 	///
-	LedDevicePiBlaster(const QJsonObject &deviceConfig);
+	explicit LedDevicePiBlaster(const QJsonObject &deviceConfig);

-	virtual ~LedDevicePiBlaster();
+	virtual ~LedDevicePiBlaster() override;

 	///
 	/// Sets configuration
 	///
 	/// @param deviceConfig the json device config
 	/// @return true if success
-	bool init(const QJsonObject &deviceConfig);
+	bool init(const QJsonObject &deviceConfig) override;

 	/// constructs leddevice
 	static LedDevice* construct(const QJsonObject &deviceConfig);
-	
+
+public slots:
+	///
+	/// Closes the output device.
+	/// Includes switching-off the device and stopping refreshes
+	///
+	virtual void close() override;
+
+protected:
 	///
 	/// Attempts to open the piblaster-device. This will only succeed if the device is not yet open
 	/// and the device is available.
 	///
 	/// @return Zero on succes else negative
 	///
-	int open();
+	int open() override;

 private:
 	///
@@ -45,7 +53,7 @@ private:
 	///
 	/// @return Zero on success else negative
 	///
-	int write(const std::vector<ColorRgb> &ledValues);
+	int write(const std::vector<ColorRgb> &ledValues) override;

 	/// The name of the output device (very likely '/dev/pi-blaster')
 	QString _deviceName;