2013-07-26 22:38:34 +02:00
|
|
|
#pragma once
|
|
|
|
|
2019-07-14 22:43:22 +02:00
|
|
|
// qt includes
|
2016-09-23 08:49:22 +02:00
|
|
|
#include <QObject>
|
|
|
|
#include <QString>
|
2016-10-13 21:59:58 +02:00
|
|
|
#include <QJsonObject>
|
|
|
|
#include <QJsonArray>
|
|
|
|
#include <QJsonDocument>
|
2019-07-14 22:43:22 +02:00
|
|
|
#include <QTimer>
|
2020-06-28 23:05:32 +02:00
|
|
|
#include <QDateTime>
|
2016-09-23 08:49:22 +02:00
|
|
|
|
2019-07-14 22:43:22 +02:00
|
|
|
// STL includes
|
2013-07-26 22:38:34 +02:00
|
|
|
#include <vector>
|
2016-08-23 20:07:12 +02:00
|
|
|
#include <map>
|
2016-09-23 08:49:22 +02:00
|
|
|
#include <algorithm>
|
2016-08-14 10:46:44 +02:00
|
|
|
|
2013-07-26 22:38:34 +02:00
|
|
|
// Utility includes
|
2013-11-11 10:00:37 +01:00
|
|
|
#include <utils/ColorRgb.h>
|
2016-05-31 22:55:56 +02:00
|
|
|
#include <utils/ColorRgbw.h>
|
|
|
|
#include <utils/RgbToRgbw.h>
|
2016-06-25 22:08:17 +02:00
|
|
|
#include <utils/Logger.h>
|
2016-08-23 20:07:12 +02:00
|
|
|
#include <functional>
|
2017-03-21 17:55:46 +01:00
|
|
|
#include <utils/Components.h>
|
2016-08-23 20:07:12 +02:00
|
|
|
|
|
|
|
class LedDevice;
|
|
|
|
|
2016-10-13 21:59:58 +02:00
|
|
|
typedef LedDevice* ( *LedDeviceCreateFuncType ) ( const QJsonObject& );
|
2017-03-04 22:17:42 +01:00
|
|
|
typedef std::map<QString,LedDeviceCreateFuncType> LedDeviceRegistry;
|
2013-07-26 22:38:34 +02:00
|
|
|
|
2013-09-06 21:26:58 +02:00
|
|
|
///
|
|
|
|
/// Interface (pure virtual base class) for LedDevices.
|
|
|
|
///
|
2016-08-14 10:46:44 +02:00
|
|
|
class LedDevice : public QObject
|
2013-07-26 22:38:34 +02:00
|
|
|
{
|
2016-08-14 10:46:44 +02:00
|
|
|
Q_OBJECT
|
|
|
|
|
2013-07-26 22:38:34 +02:00
|
|
|
public:
|
2019-01-01 19:47:07 +01:00
|
|
|
LedDevice(const QJsonObject& config = QJsonObject(), QObject* parent = nullptr);
|
2020-07-12 09:19:59 +02:00
|
|
|
~LedDevice() override;
|
2013-07-26 22:38:34 +02:00
|
|
|
|
2018-12-27 23:11:32 +01:00
|
|
|
///
|
|
|
|
/// @brief Get color order of device
|
|
|
|
/// @return The color order
|
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
const QString & getColorOrder() const { return _colorOrder; }
|
2018-12-27 23:11:32 +01:00
|
|
|
|
2019-12-08 13:12:01 +01:00
|
|
|
///
|
|
|
|
/// @brief Set the current active ledDevice type
|
|
|
|
///
|
|
|
|
/// @param deviceType Device's type
|
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
void setActiveDeviceType(const QString& deviceType);
|
2019-12-08 13:12:01 +01:00
|
|
|
|
|
|
|
///
|
|
|
|
/// @brief Get the current active ledDevice type
|
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
const QString & getActiveDeviceType() const { return _activeDeviceType; }
|
2019-12-08 13:12:01 +01:00
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
void setLedCount(unsigned int ledCount);
|
|
|
|
unsigned int getLedCount() const { return _ledCount; }
|
2017-09-16 00:18:17 +02:00
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
bool enabled() const { return _enabled; }
|
2020-03-26 18:49:44 +01:00
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
int getLatchTime() const { return _latchTime_ms; }
|
2020-03-26 18:49:44 +01:00
|
|
|
void setLatchTime( int latchTime_ms );
|
2020-02-10 15:21:58 +01:00
|
|
|
|
|
|
|
///
|
|
|
|
/// Check, if device is ready to be used
|
|
|
|
/// i.e. initialisation and configuration were successfull
|
|
|
|
///
|
|
|
|
/// @return True if device is ready
|
|
|
|
///
|
|
|
|
bool isReady() const { return _deviceReady; }
|
|
|
|
|
|
|
|
///
|
|
|
|
/// Check, if device is in error state
|
|
|
|
///
|
|
|
|
/// @return True if device is in error
|
|
|
|
///
|
|
|
|
bool isInError() const { return _deviceInError; }
|
|
|
|
|
|
|
|
inline bool componentState() const { return enabled(); }
|
|
|
|
|
|
|
|
/// Prints the RGB-Color values to stdout.
|
|
|
|
///
|
|
|
|
/// @param[in] ledValues The RGB-color per led
|
|
|
|
///
|
|
|
|
static void printLedValues (const std::vector<ColorRgb>& ledValues );
|
2017-03-21 17:55:46 +01:00
|
|
|
|
2017-09-16 00:18:17 +02:00
|
|
|
|
2019-01-01 19:47:07 +01:00
|
|
|
public slots:
|
2017-09-16 00:18:17 +02:00
|
|
|
///
|
2019-01-01 19:47:07 +01:00
|
|
|
/// Is called on thread start, all construction tasks and init should run here
|
2017-09-16 00:18:17 +02:00
|
|
|
///
|
2020-07-12 09:19:59 +02:00
|
|
|
virtual void start() { _deviceReady = (open() == 0); }
|
2017-09-16 00:18:17 +02:00
|
|
|
|
2016-09-23 08:49:22 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
/// Update the RGB-Color values to the leds.
|
|
|
|
/// Handles refreshing of leds.
|
2016-09-23 08:49:22 +02:00
|
|
|
///
|
|
|
|
/// @param[in] ledValues The RGB-color per led
|
2020-02-10 15:21:58 +01:00
|
|
|
/// @return Zero on success else negative (i.e. device is not ready)
|
2016-09-23 08:49:22 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
virtual int updateLeds(const std::vector<ColorRgb>& ledValues);
|
|
|
|
|
2016-09-23 08:49:22 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
/// Closes the output device.
|
|
|
|
/// Includes switching-off the device and stopping refreshes
|
|
|
|
///
|
|
|
|
virtual void close();
|
|
|
|
|
|
|
|
///
|
|
|
|
/// Enables/disables the device for output.
|
|
|
|
/// If the device is not ready, it will not be enabled
|
|
|
|
///
|
|
|
|
/// @param enable The new state of the device
|
|
|
|
///
|
|
|
|
void setEnable(bool enable); ///
|
2019-01-01 19:47:07 +01:00
|
|
|
|
|
|
|
signals:
|
|
|
|
///
|
|
|
|
/// Emits whenever the led device switches between on/off
|
|
|
|
/// @param newState The new state of the device
|
|
|
|
///
|
|
|
|
void enableStateChanged(bool newState);
|
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
protected:
|
|
|
|
|
2019-07-02 19:06:36 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
/// Initialise a device's configuration
|
2019-07-02 19:06:36 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
/// @param deviceConfig the json device config
|
|
|
|
/// @return True if success
|
2019-07-02 19:06:36 +02:00
|
|
|
///
|
2016-12-02 12:07:24 +01:00
|
|
|
virtual bool init(const QJsonObject &deviceConfig);
|
2016-09-23 08:49:22 +02:00
|
|
|
|
2019-01-01 19:47:07 +01:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
/// Opens and initiatialises the output device
|
2019-01-01 19:47:07 +01:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
/// @return Zero on succes (i.e. device is ready and enabled) else negative
|
2019-01-01 19:47:07 +01:00
|
|
|
///
|
|
|
|
virtual int open();
|
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
///
|
|
|
|
/// 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) = 0;
|
|
|
|
|
2019-12-08 13:12:01 +01:00
|
|
|
///
|
|
|
|
/// Writes "BLACK" to the output stream
|
|
|
|
///
|
|
|
|
/// @return Zero on success else negative
|
|
|
|
///
|
|
|
|
virtual int writeBlack();
|
|
|
|
|
2019-01-01 19:47:07 +01:00
|
|
|
// Helper to pipe device config from constructor to start()
|
|
|
|
QJsonObject _devConfig;
|
|
|
|
|
2016-08-14 10:46:44 +02:00
|
|
|
/// The common Logger instance for all LedDevices
|
2016-06-25 22:08:17 +02:00
|
|
|
Logger * _log;
|
2016-08-14 10:46:44 +02:00
|
|
|
|
|
|
|
/// The buffer containing the packed RGB values
|
|
|
|
std::vector<uint8_t> _ledBuffer;
|
|
|
|
|
2016-10-08 08:14:36 +02:00
|
|
|
bool _deviceReady;
|
2020-02-10 15:21:58 +01:00
|
|
|
bool _deviceInError;
|
2016-10-08 08:14:36 +02:00
|
|
|
|
2019-12-08 13:12:01 +01:00
|
|
|
QString _activeDeviceType;
|
2016-10-08 08:14:36 +02:00
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
unsigned int _ledCount;
|
|
|
|
unsigned int _ledRGBCount;
|
|
|
|
unsigned int _ledRGBWCount;
|
2016-11-29 23:14:15 +01:00
|
|
|
|
|
|
|
/// Timer object which makes sure that led data is written at a minimum rate
|
|
|
|
/// e.g. Adalight device will switch off when it does not receive data at least every 15 seconds
|
2020-02-10 15:21:58 +01:00
|
|
|
QTimer* _refresh_timer;
|
add Hue EntertainmentAPI + Forwarder & other Fixes (#592)
* whitespaces + typo fixes
* JS / LGTM fixes
* SSDP Handler crash fix
* MessageForwarder handlePriorityChanges Slave fixes
* use aboutToQuit Signal
* complete rewriten Hue Entertainment API structure
combined Philips Hue and Entertainment API
with new MbedTLS based SSL UDP Provider
* add required cross-compile submodules
* logical rebuild fn: initLeds, setLights + new logs
-more detailed checks and error handling inside iniLeds and setLights
- logical script procedure before ProviderUdpSSL init
- first steps for multiple ProviderUdpSSL usage
- better fallback support to old RestAPI, if entertainment api is not supported
- just 4 u LordGrey: new log fn for cosmetic config outputs ;)
* add OSX CompileHowTo - undo from CrossCompileHowTo
* whitespace fixes
* lightID toString fix
* fix unsigned int E-API + debug output
* bugfixes, reworked black signal detection, wizard:
- change device config field light-ids from int to string -> real unsigned int fix
- add signal detection brightness minimum threshold value
0.0 for 0% brightness - 1.0 for 100% brightness to count for blacklight signal detection
reason: input may not 100% black, like mine - i have a deep dark gray input signal
-> my threshold value is set to 0.005 for 0.5% minimum brightness = 1 (from max 255) to count as black
- wizard optimations, with fallback without entertainment support (beta state)
- whitespace fixes
* cleanup + minor fixes
* change fixed Hue UPD SSL config to _devConfig paras
* Hotfix SSL Connection, new light models, wizard:
- Fix UPD SSL Connection failed Problems
- add new supported gamut C light models: LCG002, LCA001, LCA002, LCA003
- wizard: extend fallback support to classic mode + hints
* whitespace, typo fix
* uncheck useEntertainmentAPI, if noAPISupport detected + hint
* coredump fix -> add _blackLightsTimer nullptr init
* code cleanup / remove old debugs + whitespacefixes
* add gamut C LCP001, LCP002
* SSL UDP config made more flexible + remove qDebug
-> switch to hyerion.ng _log
-> replace logCommand with verbose
-> code cleanups etc...
* extended mbedtls debugging infos
* add adjustable ssl timeout settings
* error handling
* streamdebugger bugfixes
* UPDSSL psk / psk_identity bugfixes! + hue wizard fn typo fix +
- verbose option available without dependencies
- whitespace fixes
* Philips Hue Assistant now recognizes non-original bridges better...
+ Added note if no clientkey is set when using the entertainment API
+ User creation (+ clientkey) for non-original bridges can now also be used
+ Minor changes and bug fixes
* CMAKE mbedTLS detection
* minor bug fixes + code cleanups
* FindMbedTLS.cmake remove Path-Hints + wizard.js: ajax timeout handling
Test - content_grabber.js: run relevant code only, if V4L2_AVAIL is true:
conf_grabber don't displays other devices, if V4L2 is not available
* compile mbedtls via cmake as static lib
* remove libmbedtls-dev from compileHowto / scripts
* Fix Windows build
* Fix windows build (part 2)
* removed unnecessary osx x11 include directory path
* QTimer Shutdown bugfix
* cmake win32 fix + minor bugfixes
* cmake debug msg used mbedtls libs
* Bugfix: noSignalDetection wasn't switchedOn again
if no signal was previously detected
* Some code fixes based on alerts from lgtm.com
Co-authored-by: Paulchen Panther <16664240+Paulchen-Panther@users.noreply.github.com>
2020-05-22 19:40:50 +02:00
|
|
|
int _refresh_timer_interval;
|
2020-02-10 15:21:58 +01:00
|
|
|
|
2020-06-28 23:05:32 +02:00
|
|
|
/// Timestamp of last write
|
|
|
|
QDateTime _lastWriteTime;
|
2020-02-10 15:21:58 +01:00
|
|
|
|
|
|
|
/// Time a device requires mandatorily between two writes
|
add Hue EntertainmentAPI + Forwarder & other Fixes (#592)
* whitespaces + typo fixes
* JS / LGTM fixes
* SSDP Handler crash fix
* MessageForwarder handlePriorityChanges Slave fixes
* use aboutToQuit Signal
* complete rewriten Hue Entertainment API structure
combined Philips Hue and Entertainment API
with new MbedTLS based SSL UDP Provider
* add required cross-compile submodules
* logical rebuild fn: initLeds, setLights + new logs
-more detailed checks and error handling inside iniLeds and setLights
- logical script procedure before ProviderUdpSSL init
- first steps for multiple ProviderUdpSSL usage
- better fallback support to old RestAPI, if entertainment api is not supported
- just 4 u LordGrey: new log fn for cosmetic config outputs ;)
* add OSX CompileHowTo - undo from CrossCompileHowTo
* whitespace fixes
* lightID toString fix
* fix unsigned int E-API + debug output
* bugfixes, reworked black signal detection, wizard:
- change device config field light-ids from int to string -> real unsigned int fix
- add signal detection brightness minimum threshold value
0.0 for 0% brightness - 1.0 for 100% brightness to count for blacklight signal detection
reason: input may not 100% black, like mine - i have a deep dark gray input signal
-> my threshold value is set to 0.005 for 0.5% minimum brightness = 1 (from max 255) to count as black
- wizard optimations, with fallback without entertainment support (beta state)
- whitespace fixes
* cleanup + minor fixes
* change fixed Hue UPD SSL config to _devConfig paras
* Hotfix SSL Connection, new light models, wizard:
- Fix UPD SSL Connection failed Problems
- add new supported gamut C light models: LCG002, LCA001, LCA002, LCA003
- wizard: extend fallback support to classic mode + hints
* whitespace, typo fix
* uncheck useEntertainmentAPI, if noAPISupport detected + hint
* coredump fix -> add _blackLightsTimer nullptr init
* code cleanup / remove old debugs + whitespacefixes
* add gamut C LCP001, LCP002
* SSL UDP config made more flexible + remove qDebug
-> switch to hyerion.ng _log
-> replace logCommand with verbose
-> code cleanups etc...
* extended mbedtls debugging infos
* add adjustable ssl timeout settings
* error handling
* streamdebugger bugfixes
* UPDSSL psk / psk_identity bugfixes! + hue wizard fn typo fix +
- verbose option available without dependencies
- whitespace fixes
* Philips Hue Assistant now recognizes non-original bridges better...
+ Added note if no clientkey is set when using the entertainment API
+ User creation (+ clientkey) for non-original bridges can now also be used
+ Minor changes and bug fixes
* CMAKE mbedTLS detection
* minor bug fixes + code cleanups
* FindMbedTLS.cmake remove Path-Hints + wizard.js: ajax timeout handling
Test - content_grabber.js: run relevant code only, if V4L2_AVAIL is true:
conf_grabber don't displays other devices, if V4L2 is not available
* compile mbedtls via cmake as static lib
* remove libmbedtls-dev from compileHowto / scripts
* Fix Windows build
* Fix windows build (part 2)
* removed unnecessary osx x11 include directory path
* QTimer Shutdown bugfix
* cmake win32 fix + minor bugfixes
* cmake debug msg used mbedtls libs
* Bugfix: noSignalDetection wasn't switchedOn again
if no signal was previously detected
* Some code fixes based on alerts from lgtm.com
Co-authored-by: Paulchen Panther <16664240+Paulchen-Panther@users.noreply.github.com>
2020-05-22 19:40:50 +02:00
|
|
|
int _latchTime_ms;
|
2020-02-10 15:21:58 +01:00
|
|
|
|
2016-11-29 23:14:15 +01:00
|
|
|
protected slots:
|
2020-02-10 15:21:58 +01:00
|
|
|
|
2016-11-29 23:14:15 +01:00
|
|
|
/// Write the last data to the leds again
|
2020-02-10 15:21:58 +01:00
|
|
|
///
|
|
|
|
/// @return Zero on success else negative
|
|
|
|
///
|
2016-11-29 23:14:15 +01:00
|
|
|
int rewriteLeds();
|
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
/// Switch the leds off
|
|
|
|
/// Writes "Black to LED" or may switch-off the LED hardware, if supported
|
|
|
|
///
|
|
|
|
virtual int switchOff();
|
|
|
|
|
|
|
|
/// Switch the leds on
|
|
|
|
/// May switch-on the LED hardware, if supported
|
|
|
|
///
|
|
|
|
virtual int switchOn();
|
|
|
|
|
|
|
|
/// Set device in error state
|
|
|
|
///
|
|
|
|
/// @param errorMsg The error message to be logged
|
|
|
|
///
|
add Hue EntertainmentAPI + Forwarder & other Fixes (#592)
* whitespaces + typo fixes
* JS / LGTM fixes
* SSDP Handler crash fix
* MessageForwarder handlePriorityChanges Slave fixes
* use aboutToQuit Signal
* complete rewriten Hue Entertainment API structure
combined Philips Hue and Entertainment API
with new MbedTLS based SSL UDP Provider
* add required cross-compile submodules
* logical rebuild fn: initLeds, setLights + new logs
-more detailed checks and error handling inside iniLeds and setLights
- logical script procedure before ProviderUdpSSL init
- first steps for multiple ProviderUdpSSL usage
- better fallback support to old RestAPI, if entertainment api is not supported
- just 4 u LordGrey: new log fn for cosmetic config outputs ;)
* add OSX CompileHowTo - undo from CrossCompileHowTo
* whitespace fixes
* lightID toString fix
* fix unsigned int E-API + debug output
* bugfixes, reworked black signal detection, wizard:
- change device config field light-ids from int to string -> real unsigned int fix
- add signal detection brightness minimum threshold value
0.0 for 0% brightness - 1.0 for 100% brightness to count for blacklight signal detection
reason: input may not 100% black, like mine - i have a deep dark gray input signal
-> my threshold value is set to 0.005 for 0.5% minimum brightness = 1 (from max 255) to count as black
- wizard optimations, with fallback without entertainment support (beta state)
- whitespace fixes
* cleanup + minor fixes
* change fixed Hue UPD SSL config to _devConfig paras
* Hotfix SSL Connection, new light models, wizard:
- Fix UPD SSL Connection failed Problems
- add new supported gamut C light models: LCG002, LCA001, LCA002, LCA003
- wizard: extend fallback support to classic mode + hints
* whitespace, typo fix
* uncheck useEntertainmentAPI, if noAPISupport detected + hint
* coredump fix -> add _blackLightsTimer nullptr init
* code cleanup / remove old debugs + whitespacefixes
* add gamut C LCP001, LCP002
* SSL UDP config made more flexible + remove qDebug
-> switch to hyerion.ng _log
-> replace logCommand with verbose
-> code cleanups etc...
* extended mbedtls debugging infos
* add adjustable ssl timeout settings
* error handling
* streamdebugger bugfixes
* UPDSSL psk / psk_identity bugfixes! + hue wizard fn typo fix +
- verbose option available without dependencies
- whitespace fixes
* Philips Hue Assistant now recognizes non-original bridges better...
+ Added note if no clientkey is set when using the entertainment API
+ User creation (+ clientkey) for non-original bridges can now also be used
+ Minor changes and bug fixes
* CMAKE mbedTLS detection
* minor bug fixes + code cleanups
* FindMbedTLS.cmake remove Path-Hints + wizard.js: ajax timeout handling
Test - content_grabber.js: run relevant code only, if V4L2_AVAIL is true:
conf_grabber don't displays other devices, if V4L2 is not available
* compile mbedtls via cmake as static lib
* remove libmbedtls-dev from compileHowto / scripts
* Fix Windows build
* Fix windows build (part 2)
* removed unnecessary osx x11 include directory path
* QTimer Shutdown bugfix
* cmake win32 fix + minor bugfixes
* cmake debug msg used mbedtls libs
* Bugfix: noSignalDetection wasn't switchedOn again
if no signal was previously detected
* Some code fixes based on alerts from lgtm.com
Co-authored-by: Paulchen Panther <16664240+Paulchen-Panther@users.noreply.github.com>
2020-05-22 19:40:50 +02:00
|
|
|
virtual void setInError( const QString& errorMsg);
|
2020-02-10 15:21:58 +01:00
|
|
|
|
2016-11-29 23:14:15 +01:00
|
|
|
private:
|
2020-02-10 15:21:58 +01:00
|
|
|
|
|
|
|
/// Start new refresh cycle
|
|
|
|
///
|
|
|
|
void startRefreshTimer();
|
|
|
|
|
|
|
|
/// Stop refresh cycle
|
|
|
|
///
|
|
|
|
void stopRefreshTimer();
|
|
|
|
|
|
|
|
|
|
|
|
bool _componentRegistered;
|
|
|
|
bool _enabled;
|
|
|
|
bool _refresh_enabled;
|
|
|
|
QString _colorOrder;
|
|
|
|
|
|
|
|
/// Last LED values written
|
|
|
|
std::vector<ColorRgb> _last_ledValues;
|
2013-07-26 22:38:34 +02:00
|
|
|
};
|