2020-07-12 20:27:56 +02:00
|
|
|
#ifndef LEDEVICEWS2801_H
|
|
|
|
#define LEDEVICEWS2801_H
|
2013-07-26 22:38:34 +02:00
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
// hyperion includes
|
2016-08-28 07:12:48 +02:00
|
|
|
#include "ProviderSpi.h"
|
2013-07-26 22:38:34 +02:00
|
|
|
|
2013-09-09 04:54:13 +02:00
|
|
|
///
|
|
|
|
/// Implementation of the LedDevice interface for writing to Ws2801 led device.
|
|
|
|
///
|
2016-08-28 07:12:48 +02:00
|
|
|
class LedDeviceWs2801 : public ProviderSpi
|
2013-07-26 22:38:34 +02:00
|
|
|
{
|
|
|
|
public:
|
2020-07-12 20:27:56 +02:00
|
|
|
|
2013-09-09 04:54:13 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Constructs a Ws2801 LED-device
|
2013-09-09 04:54:13 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param deviceConfig Device's configuration as JSON-Object
|
2013-09-09 04:54:13 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
explicit LedDeviceWs2801(const QJsonObject &deviceConfig);
|
2013-07-26 22:38:34 +02:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
///
|
|
|
|
/// @brief Constructs the LED-device
|
|
|
|
///
|
|
|
|
/// @param[in] deviceConfig Device's configuration as JSON-Object
|
|
|
|
/// @return LedDevice constructed
|
2016-10-13 21:59:58 +02:00
|
|
|
static LedDevice* construct(const QJsonObject &deviceConfig);
|
2016-02-13 13:00:31 +01:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
private:
|
|
|
|
|
|
|
|
///
|
|
|
|
/// @brief Initialise the device's configuration
|
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
|
2020-02-10 15:21:58 +01:00
|
|
|
///
|
|
|
|
virtual bool init(const QJsonObject &deviceConfig) override;
|
|
|
|
|
2013-09-09 04:54:13 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Writes the RGB-Color values to the LEDs.
|
2013-09-09 04:54:13 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] ledValues The RGB-color per LED
|
|
|
|
/// @return Zero on success, else negative
|
2013-09-09 04:54:13 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
virtual int write(const std::vector<ColorRgb> & ledValues) override;
|
2013-07-26 22:38:34 +02:00
|
|
|
};
|
2020-07-12 20:27:56 +02:00
|
|
|
|
|
|
|
#endif // LEDEVICEWS2801_H
|