From ce7c99d2cd3e1ed5ab936e3b3ed3ca4a5fd02300 Mon Sep 17 00:00:00 2001 From: LordGrey <48840279+Lord-Grey@users.noreply.github.com> Date: Sun, 8 Dec 2019 13:12:01 +0100 Subject: [PATCH] Stop LedDevice:write for disabled devices + Nanoleaf Fixes (#629) * 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 --- assets/webconfig/i18n/de.json | 1 + assets/webconfig/i18n/en.json | 1 + include/hyperion/Hyperion.h | 9 +- include/leddevice/LedDevice.h | 26 +- include/leddevice/LedDeviceWrapper.h | 4 +- libsrc/hyperion/Hyperion.cpp | 15 +- libsrc/hyperion/LinearColorSmoothing.cpp | 16 +- libsrc/leddevice/LedDevice.cpp | 15 +- libsrc/leddevice/LedDeviceWrapper.cpp | 4 +- .../leddevice/dev_net/LedDeviceNanoleaf.cpp | 569 +++++++++--------- libsrc/leddevice/dev_net/LedDeviceNanoleaf.h | 8 + libsrc/leddevice/dev_other/LedDeviceFile.cpp | 43 +- libsrc/leddevice/dev_other/LedDeviceFile.h | 13 + libsrc/leddevice/schemas/schema-file.json | 7 + 14 files changed, 410 insertions(+), 321 deletions(-) diff --git a/assets/webconfig/i18n/de.json b/assets/webconfig/i18n/de.json index 4dca5fe7..cd941856 100644 --- a/assets/webconfig/i18n/de.json +++ b/assets/webconfig/i18n/de.json @@ -439,6 +439,7 @@ "edt_dev_spec_gpioBcm_title": "GPIO Pin", "edt_dev_spec_ledIndex_title": "LED index", "edt_dev_spec_colorComponent_title": "Farbkomponente", + "edt_dev_spec_printTimeStamp_title" : "Mit Zeitstempel", "edt_conf_general_enable_title": "Aktiviert", "edt_conf_general_enable_expl": "Wenn aktiviert, ist die Komponente aktiv.", "edt_conf_general_priority_title": "Priorität", diff --git a/assets/webconfig/i18n/en.json b/assets/webconfig/i18n/en.json index f87c7457..d77dcac4 100644 --- a/assets/webconfig/i18n/en.json +++ b/assets/webconfig/i18n/en.json @@ -438,6 +438,7 @@ "edt_dev_spec_gpioBcm_title" : "GPIO Pin", "edt_dev_spec_ledIndex_title" : "LED index", "edt_dev_spec_colorComponent_title" : "Color component", + "edt_dev_spec_printTimeStamp_title" : "Add timestamp", "edt_conf_general_enable_title" : "Activate", "edt_conf_general_enable_expl" : "If checked, the component is enabled.", "edt_conf_general_priority_title" : "Priority channel", diff --git a/include/hyperion/Hyperion.h b/include/hyperion/Hyperion.h index 40dd68db..1b606aaf 100644 --- a/include/hyperion/Hyperion.h +++ b/include/hyperion/Hyperion.h @@ -31,6 +31,8 @@ #include #include +#include + // settings utils #include @@ -227,7 +229,12 @@ public: /// @brief Get the current active led device /// @return The device nam /// e - const QString & getActiveDevice(); + const QString & getActiveDeviceType(); + + /// + /// @brief Get pointer to current LedDevice + /// + LedDevice * getActiveDevice() const; public slots: /// diff --git a/include/leddevice/LedDevice.h b/include/leddevice/LedDevice.h index bb25c812..6c7502c6 100644 --- a/include/leddevice/LedDevice.h +++ b/include/leddevice/LedDevice.h @@ -51,8 +51,18 @@ public: /// const QString & getColorOrder() { return _colorOrder; }; - void setActiveDevice(QString dev); - const QString & getActiveDevice() { return _activeDevice; }; + /// + /// @brief Set the current active ledDevice type + /// + /// @param deviceType Device's type + /// + void setActiveDeviceType(QString deviceType); + + /// + /// @brief Get the current active ledDevice type + /// + const QString & getActiveDeviceType() { return _activeDeviceType; }; + void setLedCount(int ledCount); int getLedCount() { return _ledCount; } @@ -66,7 +76,7 @@ public slots: /// /// Is called on thread start, all construction tasks and init should run here /// - virtual void start() { _deviceReady = open(); }; + virtual void start() { _deviceReady = (open() == 0 ? true : false);} /// /// Writes the RGB-Color values to the leds. @@ -102,6 +112,14 @@ protected: /// virtual int open(); + /// + /// Writes "BLACK" to the output stream + /// + /// @return Zero on success else negative + /// + virtual int writeBlack(); + + // Helper to pipe device config from constructor to start() QJsonObject _devConfig; @@ -113,7 +131,7 @@ protected: bool _deviceReady; - QString _activeDevice; + QString _activeDeviceType; int _ledCount; int _ledRGBCount; diff --git a/include/leddevice/LedDeviceWrapper.h b/include/leddevice/LedDeviceWrapper.h index b3cb9271..bfee35e6 100644 --- a/include/leddevice/LedDeviceWrapper.h +++ b/include/leddevice/LedDeviceWrapper.h @@ -50,9 +50,9 @@ public: int getLatchTime(); /// - /// @brief Get the current active ledDevice + /// @brief Get the current active ledDevice type /// - const QString & getActiveDevice(); + const QString & getActiveDeviceType(); /// /// @brief Return the last enable state diff --git a/libsrc/hyperion/Hyperion.cpp b/libsrc/hyperion/Hyperion.cpp index 908ac70d..df2089ad 100644 --- a/libsrc/hyperion/Hyperion.cpp +++ b/libsrc/hyperion/Hyperion.cpp @@ -495,9 +495,9 @@ const VideoMode & Hyperion::getCurrentVideoMode() return _currVideoMode; } -const QString & Hyperion::getActiveDevice() +const QString & Hyperion::getActiveDeviceType() { - return _ledDeviceWrapper->getActiveDevice(); + return _ledDeviceWrapper->getActiveDeviceType(); } void Hyperion::updatedComponentState(const hyperion::Components comp, const bool state) @@ -581,9 +581,18 @@ void Hyperion::update() // feed smoothing in pause mode to maintain a smooth transistion back to smooth mode if (_deviceSmooth->enabled() || _deviceSmooth->pause()) + { _deviceSmooth->setLedValues(_ledBuffer); - + } + // Smoothing is disabled if (! _deviceSmooth->enabled()) + { emit ledDeviceData(_ledBuffer); + } + } + else + { + // LEDDevice is disabled + //Debug(_log, "LEDDevice is disabled - no update required"); } } diff --git a/libsrc/hyperion/LinearColorSmoothing.cpp b/libsrc/hyperion/LinearColorSmoothing.cpp index 0acaf127..4fbfcaa3 100644 --- a/libsrc/hyperion/LinearColorSmoothing.cpp +++ b/libsrc/hyperion/LinearColorSmoothing.cpp @@ -174,8 +174,18 @@ void LinearColorSmoothing::queueColors(const std::vector & ledColors) void LinearColorSmoothing::componentStateChange(const hyperion::Components component, const bool state) { - if(component == hyperion::COMP_SMOOTHING) + if(component == hyperion::COMP_LEDDEVICE) + { setEnable(state); + } + + if(component == hyperion::COMP_SMOOTHING) + { + setEnable(state); + // update comp register + _hyperion->getComponentRegister().componentStateChanged(hyperion::COMP_SMOOTHING, state); + } + } void LinearColorSmoothing::setEnable(bool enable) @@ -185,8 +195,6 @@ void LinearColorSmoothing::setEnable(bool enable) QMetaObject::invokeMethod(_timer, "stop", Qt::QueuedConnection); _previousValues.clear(); } - // update comp register - _hyperion->getComponentRegister().componentStateChanged(hyperion::COMP_SMOOTHING, enable); } void LinearColorSmoothing::setPause(bool pause) @@ -224,7 +232,7 @@ bool LinearColorSmoothing::selectConfig(unsigned cfg, const bool& force) } _currentConfigId = cfg; //DebugIf( enabled() && !_pause, _log, "set smoothing cfg: %d, interval: %d ms, settlingTime: %d ms, updateDelay: %d frames", _currentConfigId, _updateInterval, _settlingTime, _outputDelay ); - DebugIf( _pause, _log, "set smoothing cfg: %d, pause", _currentConfigId ); + //DebugIf( _pause, _log, "set smoothing cfg: %d, pause", _currentConfigId ); return true; } diff --git a/libsrc/leddevice/LedDevice.cpp b/libsrc/leddevice/LedDevice.cpp index bf145311..7fce3e27 100644 --- a/libsrc/leddevice/LedDevice.cpp +++ b/libsrc/leddevice/LedDevice.cpp @@ -62,15 +62,15 @@ void LedDevice::setEnable(bool enable) _enabled = enable; } -void LedDevice::setActiveDevice(QString dev) +void LedDevice::setActiveDeviceType(QString deviceType) { - _activeDevice = dev; + _activeDeviceType = deviceType; } bool LedDevice::init(const QJsonObject &deviceConfig) { _colorOrder = deviceConfig["colorOrder"].toString("RGB"); - _activeDevice = deviceConfig["type"].toString("file").toLower(); + _activeDeviceType = deviceConfig["type"].toString("file").toLower(); setLedCount(deviceConfig["currentLedCount"].toInt(1)); // property injected to reflect real led count _latchTime_ms = deviceConfig["latchTime"].toInt(_latchTime_ms); @@ -108,11 +108,17 @@ int LedDevice::setLedValues(const std::vector& ledValues) return retval; } -int LedDevice::switchOff() +int LedDevice::writeBlack() { return _deviceReady ? write(std::vector(_ledCount, ColorRgb::BLACK )) : -1; } +int LedDevice::switchOff() +{ + int rc = writeBlack(); + return rc; +} + int LedDevice::switchOn() { return 0; @@ -129,3 +135,4 @@ int LedDevice::rewriteLeds() { return _enabled ? write(_ledValues) : -1; } + diff --git a/libsrc/leddevice/LedDeviceWrapper.cpp b/libsrc/leddevice/LedDeviceWrapper.cpp index a49700c2..2027a3c5 100644 --- a/libsrc/leddevice/LedDeviceWrapper.cpp +++ b/libsrc/leddevice/LedDeviceWrapper.cpp @@ -115,9 +115,9 @@ int LedDeviceWrapper::getLatchTime() return _ledDevice->getLatchTime(); } -const QString & LedDeviceWrapper::getActiveDevice() +const QString & LedDeviceWrapper::getActiveDeviceType() { - return _ledDevice->getActiveDevice(); + return _ledDevice->getActiveDeviceType(); } const QString & LedDeviceWrapper::getColorOrder() diff --git a/libsrc/leddevice/dev_net/LedDeviceNanoleaf.cpp b/libsrc/leddevice/dev_net/LedDeviceNanoleaf.cpp index 18aad5c2..ce0d54c5 100644 --- a/libsrc/leddevice/dev_net/LedDeviceNanoleaf.cpp +++ b/libsrc/leddevice/dev_net/LedDeviceNanoleaf.cpp @@ -8,6 +8,14 @@ #include #include +//std includes +#include +#include + +// +static const bool verbose = false; +static const bool verbose3 = false; + // Controller configuration settings static const char CONFIG_ADDRESS[] = "output"; //static const char CONFIG_PORT[] = "port"; @@ -45,7 +53,7 @@ const quint16 STREAM_CONTROL_DEFAULT_PORT = 60222; //Fixed port for Canvas; static const char API_DEFAULT_PORT[] = "16021"; static const char API_URL_FORMAT[] = "http://%1:%2/api/v1/%3/%4"; static const char API_ROOT[] = ""; -static const char API_EXT_MODE_STRING_V1[] = "{\"write\" : {\"command\" : \"display\", \"animType\" : \"extControl\"}}"; +//static const char API_EXT_MODE_STRING_V1[] = "{\"write\" : {\"command\" : \"display\", \"animType\" : \"extControl\"}}"; static const char API_EXT_MODE_STRING_V2[] = "{\"write\" : {\"command\" : \"display\", \"animType\" : \"extControl\", \"extControlVersion\" : \"v2\"}}"; static const char API_STATE[] ="state"; static const char API_PANELLAYOUT[] = "panelLayout"; @@ -58,184 +66,179 @@ const int SSDP_TIMEOUT = 5000; // timout in ms // Nanoleaf Panel Shapetypes enum SHAPETYPES { - TRIANGLE, - RHYTM, - SQUARE, - CONTROL_SQUARE_PRIMARY, - CONTROL_SQUARE_PASSIVE, - POWER_SUPPLY, + TRIANGLE, + RHYTM, + SQUARE, + CONTROL_SQUARE_PRIMARY, + CONTROL_SQUARE_PASSIVE, + POWER_SUPPLY, }; // Nanoleaf external control versions enum EXTCONTROLVERSIONS { - EXTCTRLVER_V1 = 1, - EXTCTRLVER_V2 + EXTCTRLVER_V1 = 1, + EXTCTRLVER_V2 }; LedDevice* LedDeviceNanoleaf::construct(const QJsonObject &deviceConfig) { - return new LedDeviceNanoleaf(deviceConfig); + return new LedDeviceNanoleaf(deviceConfig); } LedDeviceNanoleaf::LedDeviceNanoleaf(const QJsonObject &deviceConfig) - : ProviderUdp() + : ProviderUdp() { - init(deviceConfig); + _deviceReady = init(deviceConfig); } bool LedDeviceNanoleaf::init(const QJsonObject &deviceConfig) { - LedDevice::init(deviceConfig); + LedDevice::init(deviceConfig); uint configuredLedCount = static_cast(this->getLedCount()); - Debug(_log, "ActiveDevice : %s", QSTRING_CSTR( this->getActiveDevice() )); - Debug(_log, "LedCount : %d", configuredLedCount); - Debug(_log, "ColorOrder : %s", QSTRING_CSTR( this->getColorOrder() )); - Debug(_log, "LatchTime : %d", this->getLatchTime()); + Debug(_log, "DeviceType : %s", QSTRING_CSTR( this->getActiveDeviceType() )); + Debug(_log, "LedCount : %u", configuredLedCount); + Debug(_log, "ColorOrder : %s", QSTRING_CSTR( this->getColorOrder() )); + Debug(_log, "LatchTime : %d", this->getLatchTime()); - //Set hostname as per configuration and default port - _hostname = deviceConfig[ CONFIG_ADDRESS ].toString(); - _api_port = API_DEFAULT_PORT; - _auth_token = deviceConfig[ CONFIG_AUTH_TOKEN ].toString(); + //Set hostname as per configuration and default port + _hostname = deviceConfig[ CONFIG_ADDRESS ].toString(); + _api_port = API_DEFAULT_PORT; + _auth_token = deviceConfig[ CONFIG_AUTH_TOKEN ].toString(); - //If host not configured then discover device - if ( _hostname.isEmpty() ) - //Discover Nanoleaf device - if ( !discoverNanoleafDevice() ) { - throw std::runtime_error("No target IP defined nor Nanoleaf device discovered"); - } + //If host not configured then discover device + if ( _hostname.isEmpty() ) + //Discover Nanoleaf device + if ( !discoverNanoleafDevice() ) { + throw std::runtime_error("No target IP defined nor Nanoleaf device discovered"); + } - //Get Nanoleaf device details and configuration - _networkmanager = new QNetworkAccessManager(); + //Get Nanoleaf device details and configuration + _networkmanager = new QNetworkAccessManager(); - // Read Panel count and panel Ids - QString url = getUrl(_hostname, _api_port, _auth_token, API_ROOT ); - QJsonDocument doc = getJson( url ); + // Read Panel count and panel Ids + QString url = getUrl(_hostname, _api_port, _auth_token, API_ROOT ); + QJsonDocument doc = getJson( url ); - QJsonObject jsonAllPanelInfo = doc.object(); + QJsonObject jsonAllPanelInfo = doc.object(); - QString deviceName = jsonAllPanelInfo[DEV_DATA_NAME].toString(); - _deviceModel = jsonAllPanelInfo[DEV_DATA_MODEL].toString(); - QString deviceManufacturer = jsonAllPanelInfo[DEV_DATA_MANUFACTURER].toString(); - _deviceFirmwareVersion = jsonAllPanelInfo[DEV_DATA_FIRMWAREVERSION].toString(); + QString deviceName = jsonAllPanelInfo[DEV_DATA_NAME].toString(); + _deviceModel = jsonAllPanelInfo[DEV_DATA_MODEL].toString(); + QString deviceManufacturer = jsonAllPanelInfo[DEV_DATA_MANUFACTURER].toString(); + _deviceFirmwareVersion = jsonAllPanelInfo[DEV_DATA_FIRMWAREVERSION].toString(); - Debug(_log, "Name : %s", QSTRING_CSTR( deviceName )); - Debug(_log, "Model : %s", QSTRING_CSTR( _deviceModel )); - Debug(_log, "Manufacturer : %s", QSTRING_CSTR( deviceManufacturer )); - Debug(_log, "FirmwareVersion: %s", QSTRING_CSTR( _deviceFirmwareVersion)); + Debug(_log, "Name : %s", QSTRING_CSTR( deviceName )); + Debug(_log, "Model : %s", QSTRING_CSTR( _deviceModel )); + Debug(_log, "Manufacturer : %s", QSTRING_CSTR( deviceManufacturer )); + Debug(_log, "FirmwareVersion: %s", QSTRING_CSTR( _deviceFirmwareVersion)); - // Get panel details from /panelLayout/layout - QJsonObject jsonPanelLayout = jsonAllPanelInfo[API_PANELLAYOUT].toObject(); - QJsonObject jsonLayout = jsonPanelLayout[PANEL_LAYOUT].toObject(); + // Get panel details from /panelLayout/layout + QJsonObject jsonPanelLayout = jsonAllPanelInfo[API_PANELLAYOUT].toObject(); + QJsonObject jsonLayout = jsonPanelLayout[PANEL_LAYOUT].toObject(); - int panelNum = jsonLayout[PANEL_NUM].toInt(); - QJsonArray positionData = jsonLayout[PANEL_POSITIONDATA].toArray(); + uint panelNum = static_cast(jsonLayout[PANEL_NUM].toInt()); + QJsonArray positionData = jsonLayout[PANEL_POSITIONDATA].toArray(); std::map> panelMap; - // Loop over all children. - foreach (const QJsonValue & value, positionData) { - QJsonObject panelObj = value.toObject(); + // Loop over all children. + foreach (const QJsonValue & value, positionData) { + QJsonObject panelObj = value.toObject(); - unsigned int panelId = static_cast(panelObj[PANEL_ID].toInt()); - unsigned int panelX = static_cast(panelObj[PANEL_POS_X].toInt()); - unsigned int panelY = static_cast(panelObj[PANEL_POS_Y].toInt()); - unsigned int panelshapeType = static_cast(panelObj[PANEL_SHAPE_TYPE].toInt()); - //int panelOrientation = panelObj[PANEL_ORIENTATION].toInt(); - //std::cout << "Panel [" << panelId << "]" << " (" << panelX << "," << panelY << ") - Type: [" << panelshapeType << "]" << std::endl; + uint panelId = static_cast(panelObj[PANEL_ID].toInt()); + uint panelX = static_cast(panelObj[PANEL_POS_X].toInt()); + uint panelY = static_cast(panelObj[PANEL_POS_Y].toInt()); + uint panelshapeType = static_cast(panelObj[PANEL_SHAPE_TYPE].toInt()); + //uint panelOrientation = static_cast(panelObj[PANEL_ORIENTATION].toInt()); - // Skip Rhythm panels - if ( panelshapeType != RHYTM ) { - panelMap[panelY][panelX] = panelId; - } else { - Info(_log, "Rhythm panel skipped."); - } - } + DebugIf(verbose, _log, "Panel [%u] (%u,%u) - Type: [%u]", panelId, panelX, panelY, panelshapeType ); - // Sort panels top down, left right - for(auto posY = panelMap.crbegin(); posY != panelMap.crend(); ++posY) { - // posY.first is the first key + // Skip Rhythm panels + if ( panelshapeType != RHYTM ) { + panelMap[panelY][panelX] = panelId; + } else { + Info(_log, "Rhythm panel skipped."); + } + } + + // Sort panels top down, left right + for(auto posY = panelMap.crbegin(); posY != panelMap.crend(); ++posY) { + // posY.first is the first key for(auto const &posX : posY->second) { - // posX.first is the second key, posX.second is the data - //std::cout << "panelMap[" << posY->first << "][" << posX.first << "]=" << posX.second << std::endl; - _panelIds.push_back(posX.second); - } - } + // posX.first is the second key, posX.second is the data + DebugIf(verbose3, _log, "panelMap[%u][%u]=%u", posY->first, posX.first, posX.second ); + _panelIds.push_back(posX.second); + } + } this->_panelLedCount = static_cast(_panelIds.size()); - Debug(_log, "PanelsNum : %d", panelNum); - Debug(_log, "PanelLedCount : %d", _panelLedCount); + Debug(_log, "PanelsNum : %u", panelNum); + Debug(_log, "PanelLedCount : %u", _panelLedCount); - // Check. if enough panelds were found. - if (_panelLedCount < configuredLedCount) { + // Check. if enough panelds were found. + if (_panelLedCount < configuredLedCount) { - throw std::runtime_error ( (QString ("Not enough panels [%1] for configured LEDs [%2] found!").arg(_panelLedCount).arg(configuredLedCount)).toStdString() ); - } else { + throw std::runtime_error ( (QString ("Not enough panels [%1] for configured LEDs [%2] found!").arg(_panelLedCount).arg(configuredLedCount)).toStdString() ); + } else { if ( _panelLedCount > static_cast(this->getLedCount()) ) { - Warning(_log, "Nanoleaf: More panels [%d] than configured LEDs [%d].", _panelLedCount, configuredLedCount ); - } - } + Warning(_log, "Nanoleaf: More panels [%u] than configured LEDs [%u].", _panelLedCount, configuredLedCount ); + } + } // Set UDP streaming port _port = STREAM_CONTROL_DEFAULT_PORT; _defaultHost = _hostname; - switchOn(); + switchOn(); - ProviderUdp::init(deviceConfig); + ProviderUdp::init(deviceConfig); - Debug(_log, "Started successfully" ); - return true; + Debug(_log, "Started successfully" ); + return true; } bool LedDeviceNanoleaf::discoverNanoleafDevice() { - bool isDeviceFound (false); - // device searching by ssdp - QString address; - SSDPDiscover discover; + bool isDeviceFound (false); + // device searching by ssdp + QString address; + SSDPDiscover discover; - // Discover Canvas device - address = discover.getFirstService(STY_WEBSERVER, SSDP_CANVAS, SSDP_TIMEOUT); + // Discover Canvas device + address = discover.getFirstService(STY_WEBSERVER, SSDP_CANVAS, SSDP_TIMEOUT); - //No Canvas device not found - if ( address.isEmpty() ) { - // Discover Light Panels (Aurora) device - address = discover.getFirstService(STY_WEBSERVER, SSDP_LIGHTPANELS, SSDP_TIMEOUT); + //No Canvas device not found + if ( address.isEmpty() ) { + // Discover Light Panels (Aurora) device + address = discover.getFirstService(STY_WEBSERVER, SSDP_LIGHTPANELS, SSDP_TIMEOUT); - if ( address.isEmpty() ) { - Warning(_log, "No Nanoleaf device discovered"); - } - } + if ( address.isEmpty() ) { + Warning(_log, "No Nanoleaf device discovered"); + } + } - // Canvas or Light Panels found - if ( ! address.isEmpty() ) { - Info(_log, "Nanoleaf device discovered at [%s]", QSTRING_CSTR( address )); - isDeviceFound = true; - QStringList addressparts = address.split(":", QString::SkipEmptyParts); - _hostname = addressparts[0]; - _api_port = addressparts[1]; - } - return isDeviceFound; + // Canvas or Light Panels found + if ( ! address.isEmpty() ) { + Info(_log, "Nanoleaf device discovered at [%s]", QSTRING_CSTR( address )); + isDeviceFound = true; + QStringList addressparts = address.split(":", QString::SkipEmptyParts); + _hostname = addressparts[0]; + _api_port = addressparts[1]; + } + return isDeviceFound; } QJsonDocument LedDeviceNanoleaf::changeToExternalControlMode() { - QString url = getUrl(_hostname, _api_port, _auth_token, API_EFFECT ); - QJsonDocument jsonDoc; - // If device model is Light Panels (Aurora) - if ( _deviceModel == "NL22") { - _extControlVersion = EXTCTRLVER_V1; - //Enable UDP Mode v1 - jsonDoc = putJson(url, API_EXT_MODE_STRING_V1); - } - else { - _extControlVersion = EXTCTRLVER_V2; - //Enable UDP Mode v2 - jsonDoc= putJson(url, API_EXT_MODE_STRING_V2); - } - return jsonDoc; + QString url = getUrl(_hostname, _api_port, _auth_token, API_EFFECT ); + QJsonDocument jsonDoc; + + _extControlVersion = EXTCTRLVER_V2; + //Enable UDP Mode v2 + jsonDoc= putJson(url, API_EXT_MODE_STRING_V2); + + return jsonDoc; } QString LedDeviceNanoleaf::getUrl(QString host, QString port, QString auth_token, QString endpoint) const { @@ -244,230 +247,203 @@ QString LedDeviceNanoleaf::getUrl(QString host, QString port, QString auth_token QJsonDocument LedDeviceNanoleaf::getJson(QString url) const { - Debug(_log, "GET: [%s]", QSTRING_CSTR( url )); + Debug(_log, "GET: [%s]", QSTRING_CSTR( url )); - // Perfrom request - QNetworkRequest request(url); - QNetworkReply* reply = _networkmanager->get(request); - // Connect requestFinished signal to quit slot of the loop. - QEventLoop loop; - loop.connect(reply, SIGNAL(finished()), SLOT(quit())); - // Go into the loop until the request is finished. - loop.exec(); + // Perfrom request + QNetworkRequest request(url); + QNetworkReply* reply = _networkmanager->get(request); + // Connect requestFinished signal to quit slot of the loop. + QEventLoop loop; + loop.connect(reply, SIGNAL(finished()), SLOT(quit())); + // Go into the loop until the request is finished. + loop.exec(); - QJsonDocument jsonDoc; - if(reply->operation() == QNetworkAccessManager::GetOperation) - { - jsonDoc = handleReply( reply ); - } - // Free space. - reply->deleteLater(); - // Return response - return jsonDoc; + QJsonDocument jsonDoc; + if(reply->operation() == QNetworkAccessManager::GetOperation) + { + jsonDoc = handleReply( reply ); + } + // Free space. + reply->deleteLater(); + // Return response + return jsonDoc; } QJsonDocument LedDeviceNanoleaf::putJson(QString url, QString json) const { - Debug(_log, "PUT: [%s] [%s]", QSTRING_CSTR( url ), QSTRING_CSTR( json ) ); - // Perfrom request - QNetworkRequest request(url); - QNetworkReply* reply = _networkmanager->put(request, json.toUtf8()); - // Connect requestFinished signal to quit slot of the loop. - QEventLoop loop; - loop.connect(reply, SIGNAL(finished()), SLOT(quit())); - // Go into the loop until the request is finished. - loop.exec(); + Debug(_log, "PUT: [%s] [%s]", QSTRING_CSTR( url ), QSTRING_CSTR( json ) ); + // Perfrom request + QNetworkRequest request(url); + QNetworkReply* reply = _networkmanager->put(request, json.toUtf8()); + // Connect requestFinished signal to quit slot of the loop. + QEventLoop loop; + loop.connect(reply, SIGNAL(finished()), SLOT(quit())); + // Go into the loop until the request is finished. + loop.exec(); - QJsonDocument jsonDoc; - if(reply->operation() == QNetworkAccessManager::PutOperation) - { - jsonDoc = handleReply( reply ); - } - // Free space. - reply->deleteLater(); + QJsonDocument jsonDoc; + if(reply->operation() == QNetworkAccessManager::PutOperation) + { + jsonDoc = handleReply( reply ); + } + // Free space. + reply->deleteLater(); - // Return response - return jsonDoc; + // Return response + return jsonDoc; } QJsonDocument LedDeviceNanoleaf::handleReply(QNetworkReply* const &reply ) const { - QJsonDocument jsonDoc; + QJsonDocument jsonDoc; - int httpStatusCode = reply->attribute( QNetworkRequest::HttpStatusCodeAttribute ).toInt(); - if(reply->error() == - QNetworkReply::NoError) - { + int httpStatusCode = reply->attribute( QNetworkRequest::HttpStatusCodeAttribute ).toInt(); + Debug(_log, "Reply.httpStatusCode [%d]", httpStatusCode ); - if ( httpStatusCode != 204 ){ - QByteArray response = reply->readAll(); - QJsonParseError error; - jsonDoc = QJsonDocument::fromJson(response, &error); - if (error.error != QJsonParseError::NoError) - { - Error (_log, "Got invalid response"); - throw std::runtime_error(""); - } - else { - //Debug - // QString strJson(jsonDoc.toJson(QJsonDocument::Compact)); - // std::cout << strJson.toUtf8().constData() << std::endl; - } - } - } - else - { - QString errorReason; - if ( httpStatusCode > 0 ) { - QString httpReason = reply->attribute( QNetworkRequest::HttpReasonPhraseAttribute ).toString(); - QString advise; - switch ( httpStatusCode ) { - case 400: - advise = "Check Request Body"; - break; - case 401: - advise = "Check Authentication Token (API Key)"; - break; - case 404: - advise = "Check Resource given"; - break; - default: - break; - } + if(reply->error() == + QNetworkReply::NoError) + { + if ( httpStatusCode != 204 ){ + QByteArray response = reply->readAll(); + QJsonParseError error; + jsonDoc = QJsonDocument::fromJson(response, &error); + if (error.error != QJsonParseError::NoError) + { + Error (_log, "Got invalid response"); + throw std::runtime_error(""); + } + else { + //Debug + QString strJson(jsonDoc.toJson(QJsonDocument::Compact)); + DebugIf(verbose, _log, "Reply: [%s]", strJson.toUtf8().constData() ); + } + } + } + else + { + QString errorReason; + if ( httpStatusCode > 0 ) { + QString httpReason = reply->attribute( QNetworkRequest::HttpReasonPhraseAttribute ).toString(); + QString advise; + switch ( httpStatusCode ) { + case 400: + advise = "Check Request Body"; + break; + case 401: + advise = "Check Authentication Token (API Key)"; + break; + case 404: + advise = "Check Resource given"; + break; + default: + break; + } errorReason = QString ("%1:%2 [%3 %4] - %5").arg(_hostname, _api_port, QString(httpStatusCode) , httpReason); - } + } else { errorReason = QString ("%1:%2 - %3").arg(_hostname, _api_port, reply->errorString()); - } - Error (_log, "%s", QSTRING_CSTR( errorReason )); - throw std::runtime_error("Network Error"); - } - // Return response - return jsonDoc; + } + Error (_log, "%s", QSTRING_CSTR( errorReason )); + throw std::runtime_error("Network Error"); + } + // Return response + return jsonDoc; } LedDeviceNanoleaf::~LedDeviceNanoleaf() { - delete _networkmanager; + delete _networkmanager; } int LedDeviceNanoleaf::write(const std::vector & ledValues) { - int retVal = 0; - uint udpBufferSize; + int retVal = 0; + uint udpBufferSize; - //Light Panels - // nPanels 1B - // nFrames 1B - // panelID 1B - // 3B - // 1B - // tranitionTime 1B - // - //Canvas - //In order to support the much larger number of panels on Canvas, the size of the nPanels, - //panelId and tranitionTime fields have been been increased from 1B to 2B. - //The nFrames field has been dropped as it was set to 1 in v1 anyway - // - // nPanels 2B - // panelID 2B - // 3B - // 1B - // tranitionTime 2B - - - //udpBufferSize = _panelLedCount * 7 + 1; // Buffersize for LightPanels + // + // nPanels 2B + // panelID 2B + // 3B + // 1B + // tranitionTime 2B + // + // Note: Nanoleaf Light Panels (Aurora) now support External Control V2 (tested with FW 3.2.0) udpBufferSize = _panelLedCount * 8 + 2; std::vector udpbuffer; udpbuffer.resize(udpBufferSize); - uchar lowByte; // lower byte - uchar highByte; // upper byte + uchar lowByte; // lower byte + uchar highByte; // upper byte - uint i=0; + uint i=0; - // Set number of panels + // Set number of panels highByte = static_cast(_panelLedCount >>8 ); lowByte = static_cast(_panelLedCount & 0xFF); - if ( _extControlVersion == EXTCTRLVER_V2 ) { - udpbuffer[i++] = highByte; - } - udpbuffer[i++] = lowByte; + udpbuffer[i++] = highByte; + udpbuffer[i++] = lowByte; - ColorRgb color; + ColorRgb color; for ( uint panelCounter=0; panelCounter < _panelLedCount; panelCounter++ ) - { + { uint panelID = _panelIds[panelCounter]; highByte = static_cast(panelID >>8 ); lowByte = static_cast(panelID & 0xFF); - // Set panels configured + // Set panels configured if( panelCounter < static_cast(this->getLedCount()) ) { color = static_cast(ledValues.at(panelCounter)); - } - else - { - // Set panels not configed to black; - color = ColorRgb::BLACK; - //printf ("panelCounter [%d] >= panelLedCount [%d]\n", panelCounter, _panelLedCount ); - } + } + else + { + // Set panels not configed to black; + color = ColorRgb::BLACK; + DebugIf(verbose3, _log, "[%u] >= panelLedCount [%u] => Set to BLACK", panelCounter, _panelLedCount ); + } - // Set panelID - if ( _extControlVersion == EXTCTRLVER_V2 ) { - udpbuffer[i++] = highByte; - } - udpbuffer[i++] = lowByte; + // Set panelID + udpbuffer[i++] = highByte; + udpbuffer[i++] = lowByte; - // Set number of frames - V1 only - if ( _extControlVersion == EXTCTRLVER_V1 ) { - udpbuffer[i++] = 1; // No of Frames - } + // Set panel's color LEDs + udpbuffer[i++] = color.red; + udpbuffer[i++] = color.green; + udpbuffer[i++] = color.blue; - // Set panel's color LEDs - udpbuffer[i++] = color.red; - udpbuffer[i++] = color.green; - udpbuffer[i++] = color.blue; + // Set white LED + udpbuffer[i++] = 0; // W not set manually - // Set white LED - udpbuffer[i++] = 0; // W not set manually - - // Set transition time - unsigned char tranitionTime = 1; // currently fixed at value 1 which corresponds to 100ms + // Set transition time + unsigned char tranitionTime = 1; // currently fixed at value 1 which corresponds to 100ms highByte = static_cast(tranitionTime >>8 ); lowByte = static_cast(tranitionTime & 0xFF); - if ( _extControlVersion == EXTCTRLVER_V2 ) { - udpbuffer[i++] = highByte; - } - udpbuffer[i++] = lowByte; + udpbuffer[i++] = highByte; + udpbuffer[i++] = lowByte; + DebugIf(verbose3, _log, "[%u] Color: {%u,%u,%u}", panelCounter, color.red, color.green, color.blue ); - //std::cout << "[" << panelCounter << "]" << " Color: " << color << std::endl; - } - - // printf ("udpBufferSize[%d], Bytes to send [%d]\n", udpBufferSize, i); - // for ( uint c= 0; c < udpBufferSize;c++ ) - // { - // printf ("%x ", static_cast(udpbuffer[c])); - // } - // printf("\n"); + } + DebugIf(verbose3, _log, "UDP-Address [%s], UDP-Port [%u], udpBufferSize[%u], Bytes to send [%u]", QSTRING_CSTR(_address.toString()), _port, udpBufferSize, i); + DebugIf(verbose3, _log, "[%s]", uint8_vector_to_hex_string(udpbuffer).c_str() ); retVal &= writeBytes( i , udpbuffer.data()); - return retVal; + DebugIf(verbose3, _log, "writeBytes(): [%d]",retVal); + return retVal; } QString LedDeviceNanoleaf::getOnOffRequest (bool isOn ) const { - QString state = isOn ? STATE_VALUE_TRUE : STATE_VALUE_FALSE; + QString state = isOn ? STATE_VALUE_TRUE : STATE_VALUE_FALSE; return QString( "{\"%1\":{\"%2\":%3}}" ).arg(STATE_ON, STATE_ONOFF_VALUE, state); } int LedDeviceNanoleaf::switchOn() { - Debug(_log, "switchOn()"); + Debug(_log, "switchOn()"); // Set Nanoleaf to External Control (UDP) mode Debug(_log, "Set Nanoleaf to External Control (UDP) streaming mode"); @@ -478,22 +454,35 @@ int LedDeviceNanoleaf::switchOn() { _port = static_cast(jsonStreamControllInfo[STREAM_CONTROL_PORT].toInt()); } - //Switch on Nanoleaf device - QString url = getUrl(_hostname, _api_port, _auth_token, API_STATE ); - putJson(url, this->getOnOffRequest(true) ); + //Switch on Nanoleaf device + QString url = getUrl(_hostname, _api_port, _auth_token, API_STATE ); + putJson(url, this->getOnOffRequest(true) ); - return 0; + return 0; } int LedDeviceNanoleaf::switchOff() { - Debug(_log, "switchOff()"); + Debug(_log, "switchOff()"); - //Set all LEDs to Black - LedDevice::switchOff(); + //Set all LEDs to Black + int rc = writeBlack(); - //Switch off Nanoleaf device physically - QString url = getUrl(_hostname, _api_port, _auth_token, API_STATE ); - putJson(url, getOnOffRequest(false) ); + //Switch off Nanoleaf device physically + QString url = getUrl(_hostname, _api_port, _auth_token, API_STATE ); + putJson(url, getOnOffRequest(false) ); - return _deviceReady ? write(std::vector(static_cast(_ledCount), ColorRgb::BLACK )) : -1; + return rc; +} + +std::string LedDeviceNanoleaf:: uint8_vector_to_hex_string( const std::vector& buffer ) const +{ + std::stringstream ss; + ss << std::hex << std::setfill('0'); + std::vector::const_iterator it; + + for (it = buffer.begin(); it != buffer.end(); it++) + { + ss << " " << std::setw(2) << static_cast(*it); + } + return ss.str(); } diff --git a/libsrc/leddevice/dev_net/LedDeviceNanoleaf.h b/libsrc/leddevice/dev_net/LedDeviceNanoleaf.h index c0c6d4d5..11cac7eb 100644 --- a/libsrc/leddevice/dev_net/LedDeviceNanoleaf.h +++ b/libsrc/leddevice/dev_net/LedDeviceNanoleaf.h @@ -145,4 +145,12 @@ private: /// @exception runtime_error for network or request errors /// QJsonDocument handleReply(QNetworkReply* const &reply ) const; + + + /// + /// convert vector to hex string + /// + /// @param uint8_t vector + /// @return vector as string of hex values + std::string uint8_vector_to_hex_string( const std::vector& buffer ) const; }; diff --git a/libsrc/leddevice/dev_other/LedDeviceFile.cpp b/libsrc/leddevice/dev_other/LedDeviceFile.cpp index 2728440b..380862d6 100644 --- a/libsrc/leddevice/dev_other/LedDeviceFile.cpp +++ b/libsrc/leddevice/dev_other/LedDeviceFile.cpp @@ -1,9 +1,13 @@ #include "LedDeviceFile.h" +#include +#include +#include + LedDeviceFile::LedDeviceFile(const QJsonObject &deviceConfig) : LedDevice() { - init(deviceConfig); + _deviceReady = init(deviceConfig); } LedDeviceFile::~LedDeviceFile() @@ -17,23 +21,40 @@ LedDevice* LedDeviceFile::construct(const QJsonObject &deviceConfig) bool LedDeviceFile::init(const QJsonObject &deviceConfig) { - if ( _ofs.is_open() ) - { - _ofs.close(); - } - - _refresh_timer_interval = 0; LedDevice::init(deviceConfig); - - QString fileName = deviceConfig["output"].toString("/dev/null"); - _ofs.open( QSTRING_CSTR(fileName) ); + _refresh_timer_interval = 0; + _fileName = deviceConfig["output"].toString("/dev/null"); + _printTimeStamp = deviceConfig["printTimeStamp"].toBool(false); return true; } +int LedDeviceFile::open() +{ + if ( _ofs.is_open() ) + { + _ofs.close(); + } + _ofs.open( QSTRING_CSTR(_fileName) ); + return 0; +} + int LedDeviceFile::write(const std::vector & ledValues) { - _ofs << "["; + 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( + now.time_since_epoch()) % 1000; + + _ofs + << std::put_time(std::localtime(&nowAsTimeT), "%Y-%m-%d %T") + << '.' << std::setfill('0') << std::setw(3) << nowMs.count(); + + } + _ofs << " ["; for (const ColorRgb& color : ledValues) { _ofs << color; diff --git a/libsrc/leddevice/dev_other/LedDeviceFile.h b/libsrc/leddevice/dev_other/LedDeviceFile.h index 4a9e9430..338487d7 100644 --- a/libsrc/leddevice/dev_other/LedDeviceFile.h +++ b/libsrc/leddevice/dev_other/LedDeviceFile.h @@ -36,6 +36,13 @@ public: virtual bool init(const QJsonObject &deviceConfig); protected: + /// + /// Opens and configures the output file + /// + /// @return Zero on succes else negative + /// + /// + virtual int open(); /// /// Writes the given led-color values to the output stream /// @@ -47,4 +54,10 @@ protected: /// The outputstream std::ofstream _ofs; + +private: + + QString _fileName; + /// Timestamp for the output record + bool _printTimeStamp; }; diff --git a/libsrc/leddevice/schemas/schema-file.json b/libsrc/leddevice/schemas/schema-file.json index f96b0d4a..0767f499 100644 --- a/libsrc/leddevice/schemas/schema-file.json +++ b/libsrc/leddevice/schemas/schema-file.json @@ -17,6 +17,13 @@ "maximum": 1000, "access" : "expert", "propertyOrder" : 2 + }, + "printTimeStamp": { + "type": "boolean", + "title":"edt_dev_spec_printTimeStamp_title", + "default": false, + "access" : "expert", + "propertyOrder" : 3 } }, "additionalProperties": true