hyperion.ng/include/leddevice/LedDevice.h

57 lines
1015 B
C
Raw Normal View History

#pragma once
// STL incldues
#include <vector>
#include <QObject>
// Utility includes
#include <utils/ColorRgb.h>
#include <utils/ColorRgbw.h>
#include <utils/RgbToRgbw.h>
#include <utils/Logger.h>
2013-09-06 21:26:58 +02:00
///
/// Interface (pure virtual base class) for LedDevices.
///
class LedDevice : public QObject
{
Q_OBJECT
public:
LedDevice();
2013-09-09 22:35:28 +02:00
///
/// Empty virtual destructor for pure virtual base class
///
virtual ~LedDevice() {}
2013-09-09 22:35:28 +02: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;
/// Switch the leds off
virtual int switchOff() = 0;
///
/// Opens and configures the output device
///
/// @return Zero on succes else negative
///
virtual int open();
protected:
/// The common Logger instance for all LedDevices
Logger * _log;
int _ledCount;
/// The buffer containing the packed RGB values
std::vector<uint8_t> _ledBuffer;
};