LED Device Features, Fixes and Refactoring (Resubmit PR855) (#875)

* Refactor LedDevices - Initial version
* Small renamings
* Add WLED as own device
* Lpd8806 Remove open() method
* remove dependency on Qt 5.10
* Lpd8806 Remove open() method
* Update WS281x
* Update WS2812SPI
* Add writeBlack for WLED powerOff
* WLED remove extra bracket
* Allow different Nanoleaf panel numbering sequence (Feature req.#827)
* build(deps): bump websocket-extensions from 0.1.3 to 0.1.4 in /docs (#826)
* Bumps [websocket-extensions](https://github.com/faye/websocket-extensions-node) from 0.1.3 to 0.1.4.
  - [Release notes](https://github.com/faye/websocket-extensions-node/releases)
  - [Changelog](https://github.com/faye/websocket-extensions-node/blob/master/CHANGELOG.md)
  - [Commits](https://github.com/faye/websocket-extensions-node/compare/0.1.3...0.1.4)
* Fix typos
* Nanoleaf clean-up
* Yeelight support, generalize wizard elements
* Update Yeelight to handle quota in music mode
* Yeelight extend rage for extraTimeDarkness for testing
* Clean-up - Add commentary, Remove development debug statements
* Fix brightnessSwitchOffOnMinimum typo and default value
* Yeelight support restoreOriginalState, additional Fixes
* WLED - Remove UDP-Port, as it is not configurable
* Fix merging issue
* Remove QHostAddress::operator=(const QString&)' is deprecated
* Windows compile errors and (Qt 5.15 deprecation) warnings
* Fix order includes
* LedDeviceFile Support Qt5.7 and greater
* Windows compatibility and other Fixes
* Fix Qt Version compatability
* Rs232 - Resolve portname from unix /dev/ style, fix DMX sub-type support
* Disable WLED Wizard Button (until Wizard is available)
* Yeelight updates
* Add wrong log-type as per #505
* Fixes and Clean-up after clang-tidy report
* Fix udpe131 not enabled for generated CID
* Change timer into dynamic for Qt Thread-Affinity
* Hue clean-up and diyHue workaround
* Updates after review feedback by m-seker
* Add "chrono" includes

libsrc/leddevice/dev_hid/LedDeviceLightpack.h

@@ -1,4 +1,5 @@
-#pragma once
+#ifndef LEDEVICELIGHTPACK_H
+#define LEDEVICELIGHTPACK_H
 
 // stl includes
 #include <cstdint>
@@ -15,79 +16,93 @@
 class LedDeviceLightpack : public LedDevice
 {
 public:
+
 	///
-	/// Constructs the LedDeviceLightpack
+	/// @brief Constructs a Lightpack LED-device
 	///
 	/// @param serialNumber serial output device
 	///
-	LedDeviceLightpack(const QString & serialNumber = "");
+	explicit LedDeviceLightpack(const QString & serialNumber = "");
+
 	///
-	/// Constructs specific LedDevice
+	/// @brief Constructs a Lightpack LED-device
 	///
-	/// @param deviceConfig json device config
+	/// @param deviceConfig Device's configuration as JSON-Object
 	///
 	explicit LedDeviceLightpack(const QJsonObject &deviceConfig);
 
 	///
-	/// Sets configuration
-	///
-	/// @param deviceConfig the json device config
-	/// @return true if success
-	bool init(const QJsonObject &deviceConfig) override;
-
-	/// constructs leddevice
-	static LedDevice* construct(const QJsonObject &deviceConfig);
-
-	///
-	/// Destructor of the LedDevice; closes the output device if it is open
+	/// @brief Destructor of the LedDevice
 	///
 	virtual ~LedDeviceLightpack() override;
 
 	///
-	/// Opens and configures the output device
+	/// @brief Constructs the LED-device
 	///
-	/// @return Zero on succes else negative
+	/// @param[in] deviceConfig Device's configuration as JSON-Object
+	/// @return LedDevice constructed
 	///
-	int open() override;
+	static LedDevice* construct(const QJsonObject &deviceConfig);
 
 	///
-	/// Writes the RGB-Color values to the leds.
+	/// @brief Initialise the device's configuration
+	///
+	/// @param[in] deviceConfig the JSON device configuration
+	/// @return True, if success
+	///
+	virtual bool init(const QJsonObject &deviceConfig) override;
+
+	///
+	/// @brief Opens the output device.
+	///
+	/// @return Zero on success (i.e. device is ready), else negative
+	///
+	virtual int open() override;
+
+	///
+	/// @brief Closes the output device.
+	///
+	/// @return Zero on success (i.e. device is closed), else negative
+	///
+	virtual int close() override;
+
+	///
+	/// @brief Power-/turn off the Nanoleaf device.
+	///
+	/// @return True if success
+	///
+	virtual bool powerOff() override;
+
+	///
+	/// @brief Writes the RGB-Color values to the LEDs.
 	///
 	/// @param[in] ledValues  Array of RGB values
 	/// @param[in] size       The number of RGB values
 	///
-	/// @return Zero on success else negative
+	/// @return Zero on success, else negative
 	///
 	int write(const ColorRgb * ledValues, int size);
 
 	///
-	/// Switch the leds off
+	/// @brief Get the serial number of the Lightpack
 	///
-	/// @return Zero on success else negative
-	///
-	virtual int switchOff() override;
-
-	/// Get the serial of the Lightpack
+	/// @return Serial Number
+	///	///
 	const QString & getSerialNumber() const;
 
-public slots:
-	///
-	/// Closes the output device.
-	/// Includes switching-off the device and stopping refreshes
-	///
-	virtual void close() override;
+	bool isOpen(){ return _isOpen; }
 
 protected:
 
+	///
+	/// @brief Writes the RGB-Color values to the LEDs.
+	///
+	/// @param[in] ledValues The RGB-color per LED
+	/// @return Zero on success, else negative
+	///
+	virtual int write(const std::vector<ColorRgb> & ledValues) override;
+
 private:
-	///
-	/// Writes the RGB-Color values to the leds.
-	///
-	/// @param[in] ledValues  The RGB-color per led
-	///
-	/// @return Zero on success else negative
-	///
-	virtual int write(const std::vector<ColorRgb>& ledValues) override;
 
 	///
 	/// Test if the device is a (or the) lightpack we are looking for
@@ -114,6 +129,9 @@ private:
 	/// libusb context
 	libusb_context * _libusbContext;
 
+	/// libusb device
+	libusb_device * _device;
+
 	/// libusb device handle
 	libusb_device_handle * _deviceHandle;
 
@@ -134,4 +152,8 @@ private:
 
 	/// count of real hardware leds
 	int _hwLedCount;
+
+	bool _isOpen;
 };
+
+#endif // LEDEVICELIGHTPACK_H