2020-07-12 20:27:56 +02:00
|
|
|
#ifndef LEDEVICEWS281X_H
|
|
|
|
#define LEDEVICEWS281X_H
|
2016-03-04 09:07:02 +01:00
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
// LedDevice includes
|
2016-03-04 09:07:02 +01:00
|
|
|
#include <leddevice/LedDevice.h>
|
|
|
|
#include <ws2811.h>
|
|
|
|
|
2016-10-08 13:52:22 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// Implementation of the LedDevice interface for writing to WS281x LED-device via pwm.
|
2016-10-08 13:52:22 +02:00
|
|
|
///
|
2016-03-04 09:07:02 +01:00
|
|
|
class LedDeviceWS281x : public LedDevice
|
|
|
|
{
|
|
|
|
public:
|
2020-07-12 20:27:56 +02:00
|
|
|
|
2016-03-04 09:07:02 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Constructs an WS281x LED-device
|
2016-08-23 20:07:12 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param deviceConfig Device's configuration as JSON-Object
|
2016-03-04 09:07:02 +01:00
|
|
|
///
|
2020-02-14 21:58:10 +01:00
|
|
|
explicit LedDeviceWS281x(const QJsonObject &deviceConfig);
|
2016-03-04 09:07:02 +01:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Destructor of the LedDevice
|
2016-03-04 09:07:02 +01:00
|
|
|
///
|
2020-08-08 23:12:43 +02:00
|
|
|
~LedDeviceWS281x() override;
|
2020-02-10 15:21:58 +01:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
///
|
|
|
|
/// @brief Destructor of the LedDevice
|
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
static LedDevice* construct(const QJsonObject &deviceConfig);
|
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
protected:
|
|
|
|
|
|
|
|
///
|
|
|
|
/// @brief Initialise the device's configuration
|
2016-08-23 20:07:12 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] deviceConfig the JSON device configuration
|
|
|
|
/// @return True, if success
|
2016-08-23 20:07:12 +02:00
|
|
|
///
|
2020-08-08 23:12:43 +02:00
|
|
|
bool init(const QJsonObject &deviceConfig) override;
|
2016-08-23 20:07:12 +02:00
|
|
|
|
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
|
2020-02-10 15:21:58 +01:00
|
|
|
///
|
2020-08-08 23:12:43 +02:00
|
|
|
int open() override;
|
2016-03-04 09:07:02 +01:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Closes the output device.
|
|
|
|
///
|
|
|
|
/// @return Zero on success (i.e. device is closed), else negative
|
|
|
|
///
|
2020-08-08 23:12:43 +02:00
|
|
|
int close() override;
|
2020-07-12 20:27:56 +02:00
|
|
|
|
|
|
|
///
|
|
|
|
/// @brief Writes the RGB-Color values to the LEDs.
|
2016-03-04 09:07:02 +01:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] ledValues The RGB-color per LED
|
|
|
|
/// @return Zero on success, else negative
|
2016-03-04 09:07:02 +01:00
|
|
|
///
|
2020-08-08 23:12:43 +02:00
|
|
|
int write(const std::vector<ColorRgb> & ledValues) override;
|
2016-03-04 09:07:02 +01:00
|
|
|
|
2020-02-14 21:58:10 +01:00
|
|
|
private:
|
|
|
|
|
2016-08-14 10:46:44 +02:00
|
|
|
ws2811_t _led_string;
|
|
|
|
int _channel;
|
2016-10-08 08:14:36 +02:00
|
|
|
RGBW::WhiteAlgorithm _whiteAlgorithm;
|
2016-08-14 10:46:44 +02:00
|
|
|
ColorRgbw _temp_rgbw;
|
2016-03-04 09:07:02 +01:00
|
|
|
};
|
2020-07-12 20:27:56 +02:00
|
|
|
|
|
|
|
#endif // LEDEVICEWS281X_H
|