2020-07-12 20:27:56 +02:00
|
|
|
#ifndef LEDEVICEFADECANDY_H
|
|
|
|
#define LEDEVICEFADECANDY_H
|
2016-01-04 12:06:56 +01:00
|
|
|
|
2016-01-04 14:29:47 +01:00
|
|
|
// STL/Qt includes
|
2016-01-04 12:06:56 +01:00
|
|
|
#include <QTcpSocket>
|
2017-03-04 22:17:42 +01:00
|
|
|
#include <QString>
|
2016-01-04 12:06:56 +01:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
// LedDevice includes
|
2016-01-04 12:06:56 +01:00
|
|
|
#include <leddevice/LedDevice.h>
|
|
|
|
|
|
|
|
///
|
2016-01-04 14:29:47 +01:00
|
|
|
/// Implementation of the LedDevice interface for sending to
|
|
|
|
/// fadecandy/opc-server via network by using the 'open pixel control' protocol.
|
2016-01-04 12:06:56 +01:00
|
|
|
///
|
2016-08-14 10:46:44 +02:00
|
|
|
class LedDeviceFadeCandy : public LedDevice
|
2016-01-04 12:06:56 +01:00
|
|
|
{
|
2016-01-04 14:29:47 +01:00
|
|
|
Q_OBJECT
|
|
|
|
|
2016-01-04 12:06:56 +01:00
|
|
|
public:
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Constructs a LED-device for fadecandy/opc server
|
2016-01-04 14:29:47 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// Following code shows all configuration options
|
2016-07-12 22:37:45 +02:00
|
|
|
/// @code
|
|
|
|
/// "device" :
|
|
|
|
/// {
|
|
|
|
/// "name" : "MyPi",
|
|
|
|
/// "type" : "fadecandy",
|
|
|
|
/// "output" : "localhost",
|
|
|
|
/// "colorOrder" : "rgb",
|
2016-07-13 11:18:12 +02:00
|
|
|
/// "setFcConfig" : false,
|
2016-07-12 22:37:45 +02:00
|
|
|
/// "gamma" : 1.0,
|
|
|
|
/// "whitepoint" : [1.0, 1.0, 1.0],
|
|
|
|
/// "dither" : false,
|
|
|
|
/// "interpolation" : false,
|
|
|
|
/// "manualLed" : false,
|
|
|
|
/// "ledOn" : false
|
2020-08-08 00:21:19 +02:00
|
|
|
/// },
|
2016-07-12 22:37:45 +02:00
|
|
|
///@endcode
|
2016-01-04 12:06:56 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param deviceConfig Device's configuration as JSON-Object
|
2016-07-12 22:37:45 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
explicit LedDeviceFadeCandy(const QJsonObject &deviceConfig);
|
2016-01-04 12:06:56 +01:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Destructor of the LedDevice
|
2016-01-04 12:06:56 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
~LedDeviceFadeCandy() override;
|
2016-08-23 20:07:12 +02:00
|
|
|
|
2016-07-12 22:37:45 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Constructs the LED-device
|
2016-07-12 22:37:45 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] deviceConfig Device's configuration as JSON-Object
|
|
|
|
/// @return LedDevice constructed
|
|
|
|
static LedDevice* construct(const QJsonObject &deviceConfig);
|
2020-02-10 15:21:58 +01:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
protected:
|
2020-02-10 15:21:58 +01:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Initialise the Nanoleaf device's configuration and network address details
|
2020-02-10 15:21:58 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] deviceConfig the JSON device configuration
|
|
|
|
/// @return True, if success
|
|
|
|
///
|
|
|
|
virtual bool init(const QJsonObject &deviceConfig) override;
|
2020-02-10 15:21:58 +01:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
///
|
|
|
|
/// @brief Opens the output device.
|
|
|
|
///
|
|
|
|
/// @return Zero on success (i.e. device is ready), else negative
|
|
|
|
///
|
|
|
|
virtual int open() override;
|
2020-02-10 15:21:58 +01:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Closes the output device.
|
2020-02-10 15:21:58 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @return Zero on success (i.e. device is closed), else negative
|
|
|
|
///
|
|
|
|
virtual int close() override;
|
2020-02-10 15:21:58 +01:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Writes the RGB-Color values to the LEDs.
|
2020-02-10 15:21:58 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] ledValues The RGB-color per LED
|
|
|
|
/// @return Zero on success, else negative
|
2020-02-10 15:21:58 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
virtual int write(const std::vector<ColorRgb> & ledValues) override;
|
2016-07-12 22:37:45 +02:00
|
|
|
|
2019-07-02 19:06:36 +02:00
|
|
|
private:
|
2020-07-12 20:27:56 +02:00
|
|
|
|
2016-01-04 12:06:56 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Initialise device's network details
|
2016-01-04 12:06:56 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @return True if success
|
|
|
|
bool initNetwork();
|
2016-01-04 14:29:47 +01:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief try to establish connection to opc server, if not connected yet
|
|
|
|
///
|
|
|
|
/// @return True, if connection is established
|
2016-01-04 14:29:47 +01:00
|
|
|
///
|
|
|
|
bool tryConnect();
|
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Return the connection state
|
|
|
|
///
|
|
|
|
/// @return True, if connection established
|
2016-01-04 14:29:47 +01:00
|
|
|
///
|
|
|
|
bool isConnected();
|
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Transfer current opc_data buffer to opc server
|
|
|
|
///
|
|
|
|
/// @return amount of transferred bytes. -1 error while transferring, -2 error while connecting
|
2016-01-04 14:29:47 +01:00
|
|
|
///
|
|
|
|
int transferData();
|
2020-08-08 00:21:19 +02:00
|
|
|
|
2016-07-12 22:37:45 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Send system exclusive commands
|
|
|
|
///
|
|
|
|
/// @param[in] systemId fadecandy device identifier (for standard fadecandy always: 1)
|
|
|
|
/// @param[in] commandId id of command
|
|
|
|
/// @param[in] msg the sysEx message
|
|
|
|
/// @return amount bytes written, -1 if failed
|
2016-07-12 22:37:45 +02:00
|
|
|
int sendSysEx(uint8_t systemId, uint8_t commandId, QByteArray msg);
|
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
///
|
|
|
|
/// @brief Sends the configuration to fadecandy cserver
|
|
|
|
///
|
2016-07-12 22:37:45 +02:00
|
|
|
void sendFadeCandyConfiguration();
|
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
QTcpSocket* _client;
|
|
|
|
QString _host;
|
|
|
|
uint16_t _port;
|
|
|
|
unsigned _channel;
|
|
|
|
QByteArray _opc_data;
|
|
|
|
|
|
|
|
// fadecandy sysEx
|
|
|
|
bool _setFcConfig;
|
|
|
|
double _gamma;
|
|
|
|
double _whitePoint_r;
|
|
|
|
double _whitePoint_g;
|
|
|
|
double _whitePoint_b;
|
|
|
|
bool _noDither;
|
|
|
|
bool _noInterp;
|
|
|
|
bool _manualLED;
|
|
|
|
bool _ledOnOff;
|
|
|
|
|
2016-01-04 12:06:56 +01:00
|
|
|
};
|
2020-07-12 20:27:56 +02:00
|
|
|
|
|
|
|
#endif // LEDEVICEFADECANDY_H
|