frodovdr/hyperion.ng
1
0
Fork 0
mirror of https://github.com/hyperion-project/hyperion.ng.git synced 2025-03-01 10:33:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Stop LedDevice:write for disabled devices + Nanoleaf Fixes (#629)

Browse Source 
* 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
This commit is contained in:
LordGrey 2019-12-08 13:12:01 +01:00 committed by Paulchen Panther
parent f917f0fceb
commit ce7c99d2cd
14 changed files with 410 additions and 321 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
assets/webconfig/i18n/de.json
View File

@ -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",

1
assets/webconfig/i18n/en.json
View File

@ -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",

9
include/hyperion/Hyperion.h
View File

@ -31,6 +31,8 @@
#include <effectengine/ActiveEffectDefinition.h>
#include <effectengine/EffectSchema.h>
#include <leddevice/LedDevice.h>
// settings utils
#include <utils/settings.h>
@ -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:
///

26
include/leddevice/LedDevice.h
View File

@ -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;

4
include/leddevice/LedDeviceWrapper.h
View File

@ -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

15
libsrc/hyperion/Hyperion.cpp
View File

@ -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");
}
}

16
libsrc/hyperion/LinearColorSmoothing.cpp
View File

@ -174,8 +174,18 @@ void LinearColorSmoothing::queueColors(const std::vector<ColorRgb> & 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;
}

15
libsrc/leddevice/LedDevice.cpp
View File

@ -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<ColorRgb>& ledValues)
return retval;
}
int LedDevice::switchOff()
int LedDevice::writeBlack()
{
return _deviceReady ? write(std::vector<ColorRgb>(_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;
}

4
libsrc/leddevice/LedDeviceWrapper.cpp
View File

@ -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()

115
libsrc/leddevice/dev_net/LedDeviceNanoleaf.cpp
View File

@ -8,6 +8,14 @@
#include <QEventLoop>
#include <QNetworkReply>
//std includes
#include <sstream>
#include <iomanip>
//
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";
@ -80,7 +88,7 @@ LedDevice* LedDeviceNanoleaf::construct(const QJsonObject &deviceConfig)
LedDeviceNanoleaf::LedDeviceNanoleaf(const QJsonObject &deviceConfig)
: ProviderUdp()
{
init(deviceConfig);
_deviceReady = init(deviceConfig);
}
bool LedDeviceNanoleaf::init(const QJsonObject &deviceConfig) {
@ -88,8 +96,8 @@ bool LedDeviceNanoleaf::init(const QJsonObject &deviceConfig) {
LedDevice::init(deviceConfig);
uint configuredLedCount = static_cast<uint>(this->getLedCount());
Debug(_log, "ActiveDevice : %s", QSTRING_CSTR( this->getActiveDevice() ));
Debug(_log, "LedCount : %d", configuredLedCount);
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());
@ -128,7 +136,7 @@ bool LedDeviceNanoleaf::init(const QJsonObject &deviceConfig) {
QJsonObject jsonPanelLayout = jsonAllPanelInfo[API_PANELLAYOUT].toObject();
QJsonObject jsonLayout = jsonPanelLayout[PANEL_LAYOUT].toObject();
int panelNum = jsonLayout[PANEL_NUM].toInt();
uint panelNum = static_cast<uint>(jsonLayout[PANEL_NUM].toInt());
QJsonArray positionData = jsonLayout[PANEL_POSITIONDATA].toArray();
std::map<uint, std::map<uint, uint>> panelMap;
@ -137,12 +145,13 @@ bool LedDeviceNanoleaf::init(const QJsonObject &deviceConfig) {
foreach (const QJsonValue & value, positionData) {
QJsonObject panelObj = value.toObject();
unsigned int panelId = static_cast<uint>(panelObj[PANEL_ID].toInt());
unsigned int panelX = static_cast<uint>(panelObj[PANEL_POS_X].toInt());
unsigned int panelY = static_cast<uint>(panelObj[PANEL_POS_Y].toInt());
unsigned int panelshapeType = static_cast<uint>(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<uint>(panelObj[PANEL_ID].toInt());
uint panelX = static_cast<uint>(panelObj[PANEL_POS_X].toInt());
uint panelY = static_cast<uint>(panelObj[PANEL_POS_Y].toInt());
uint panelshapeType = static_cast<uint>(panelObj[PANEL_SHAPE_TYPE].toInt());
//uint panelOrientation = static_cast<uint>(panelObj[PANEL_ORIENTATION].toInt());
DebugIf(verbose, _log, "Panel [%u] (%u,%u) - Type: [%u]", panelId, panelX, panelY, panelshapeType );
// Skip Rhythm panels
if ( panelshapeType != RHYTM ) {
@ -157,15 +166,15 @@ bool LedDeviceNanoleaf::init(const QJsonObject &deviceConfig) {
// 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;
DebugIf(verbose3, _log, "panelMap[%u][%u]=%u", posY->first, posX.first, posX.second );
_panelIds.push_back(posX.second);
}
}
this->_panelLedCount = static_cast<uint>(_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) {
@ -173,7 +182,7 @@ bool LedDeviceNanoleaf::init(const QJsonObject &deviceConfig) {
throw std::runtime_error ( (QString ("Not enough panels [%1] for configured LEDs [%2] found!").arg(_panelLedCount).arg(configuredLedCount)).toStdString() );
} else {
if ( _panelLedCount > static_cast<uint>(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 );
}
}
@ -224,17 +233,11 @@ 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;
}
@ -295,10 +298,11 @@ QJsonDocument LedDeviceNanoleaf::handleReply(QNetworkReply* const &reply ) const
QJsonDocument jsonDoc;
int httpStatusCode = reply->attribute( QNetworkRequest::HttpStatusCodeAttribute ).toInt();
Debug(_log, "Reply.httpStatusCode [%d]", httpStatusCode );
if(reply->error() ==
QNetworkReply::NoError)
{
if ( httpStatusCode != 204 ){
QByteArray response = reply->readAll();
QJsonParseError error;
@ -310,8 +314,8 @@ QJsonDocument LedDeviceNanoleaf::handleReply(QNetworkReply* const &reply ) const
}
else {
//Debug
// QString strJson(jsonDoc.toJson(QJsonDocument::Compact));
// std::cout << strJson.toUtf8().constData() << std::endl;
QString strJson(jsonDoc.toJson(QJsonDocument::Compact));
DebugIf(verbose, _log, "Reply: [%s]", strJson.toUtf8().constData() );
}
}
}
@ -358,27 +362,14 @@ int LedDeviceNanoleaf::write(const std::vector<ColorRgb> & ledValues)
int retVal = 0;
uint udpBufferSize;
//Light Panels
// nPanels 1B
// nFrames 1B
// panelID 1B
// <R> <G> <B> 3B
// <W> 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
// <R> <G> <B> 3B
// <W> 1B
// tranitionTime 2B
//udpBufferSize = _panelLedCount * 7 + 1; // Buffersize for LightPanels
//
// Note: Nanoleaf Light Panels (Aurora) now support External Control V2 (tested with FW 3.2.0)
udpBufferSize = _panelLedCount * 8 + 2;
std::vector<uint8_t> udpbuffer;
@ -393,9 +384,7 @@ int LedDeviceNanoleaf::write(const std::vector<ColorRgb> & ledValues)
highByte = static_cast<uchar>(_panelLedCount >>8 );
lowByte = static_cast<uchar>(_panelLedCount & 0xFF);
if ( _extControlVersion == EXTCTRLVER_V2 ) {
udpbuffer[i++] = highByte;
}
udpbuffer[i++] = lowByte;
ColorRgb color;
@ -414,20 +403,13 @@ int LedDeviceNanoleaf::write(const std::vector<ColorRgb> & ledValues)
{
// Set panels not configed to black;
color = ColorRgb::BLACK;
//printf ("panelCounter [%d] >= panelLedCount [%d]\n", panelCounter, _panelLedCount );
DebugIf(verbose3, _log, "[%u] >= panelLedCount [%u] => Set to BLACK", panelCounter, _panelLedCount );
}
// Set panelID
if ( _extControlVersion == EXTCTRLVER_V2 ) {
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;
@ -442,22 +424,16 @@ int LedDeviceNanoleaf::write(const std::vector<ColorRgb> & ledValues)
highByte = static_cast<uchar>(tranitionTime >>8 );
lowByte = static_cast<uchar>(tranitionTime & 0xFF);
if ( _extControlVersion == EXTCTRLVER_V2 ) {
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<uchar>(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());
DebugIf(verbose3, _log, "writeBytes(): [%d]",retVal);
return retVal;
}
@ -489,11 +465,24 @@ int LedDeviceNanoleaf::switchOff() {
Debug(_log, "switchOff()");
//Set all LEDs to Black
LedDevice::switchOff();
int rc = writeBlack();
//Switch off Nanoleaf device physically
QString url = getUrl(_hostname, _api_port, _auth_token, API_STATE );
putJson(url, getOnOffRequest(false) );
return _deviceReady ? write(std::vector<ColorRgb>(static_cast<uint>(_ledCount), ColorRgb::BLACK )) : -1;
return rc;
}
std::string LedDeviceNanoleaf:: uint8_vector_to_hex_string( const std::vector<uint8_t>& buffer ) const
{
std::stringstream ss;
ss << std::hex << std::setfill('0');
std::vector<uint8_t>::const_iterator it;
for (it = buffer.begin(); it != buffer.end(); it++)
{
ss << " " << std::setw(2) << static_cast<unsigned>(*it);
}
return ss.str();
}

8
libsrc/leddevice/dev_net/LedDeviceNanoleaf.h
View File

@ -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<uint8_t>& buffer ) const;
};

43
libsrc/leddevice/dev_other/LedDeviceFile.cpp
View File

@ -1,9 +1,13 @@
#include "LedDeviceFile.h"
#include <chrono>
#include <iomanip>
#include <iostream>
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<ColorRgb> & 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<std::chrono::milliseconds>(
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;

13
libsrc/leddevice/dev_other/LedDeviceFile.h
View File

@ -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;
};

7
libsrc/leddevice/schemas/schema-file.json
View File

@ -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