2020-07-12 20:27:56 +02:00
|
|
|
#ifndef LEDEVICEWS2812_H
|
|
|
|
#define LEDEVICEWS2812_H
|
2016-05-15 18:39:17 +02:00
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
// hyperion includes
|
2016-08-28 07:12:48 +02:00
|
|
|
#include "ProviderSpi.h"
|
2016-05-15 18:39:17 +02:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// Implementation of the LedDevice interface for writing to Ws2812 led device.
|
2016-05-15 18:39:17 +02:00
|
|
|
///
|
2016-08-28 07:12:48 +02:00
|
|
|
class LedDeviceWs2812SPI : public ProviderSpi
|
2016-05-15 18:39:17 +02:00
|
|
|
{
|
|
|
|
public:
|
2020-07-12 20:27:56 +02:00
|
|
|
|
2016-05-15 18:39:17 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Constructs a Ws2812 LED-device
|
2016-05-15 18:39:17 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param deviceConfig Device's configuration as JSON-Object
|
2016-05-15 18:39:17 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
explicit LedDeviceWs2812SPI(const QJsonObject &deviceConfig);
|
2016-08-23 20:07:12 +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-05-15 18:39:17 +02:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
private:
|
|
|
|
|
|
|
|
///
|
|
|
|
/// @brief Initialise the device's configuration
|
2016-09-23 08:49:22 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] deviceConfig the JSON device configuration
|
|
|
|
/// @return True, if success
|
2016-09-23 08:49:22 +02:00
|
|
|
///
|
2020-08-08 23:12:43 +02:00
|
|
|
bool init(const QJsonObject &deviceConfig) override;
|
2016-09-04 14:28:06 +02:00
|
|
|
|
2016-05-15 18:39:17 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Writes the RGB-Color values to the LEDs.
|
2016-05-15 18:39:17 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] ledValues The RGB-color per LED
|
|
|
|
/// @return Zero on success, else negative
|
2016-05-15 18:39:17 +02:00
|
|
|
///
|
2020-08-08 23:12:43 +02:00
|
|
|
int write(const std::vector<ColorRgb> & ledValues) override;
|
2016-12-01 16:16:59 +01:00
|
|
|
|
2020-02-10 15:21:58 +01:00
|
|
|
const int SPI_BYTES_PER_COLOUR;
|
2017-05-13 19:09:26 +02:00
|
|
|
const int SPI_FRAME_END_LATCH_BYTES;
|
|
|
|
|
2016-08-14 10:46:44 +02:00
|
|
|
uint8_t bitpair_to_byte[4];
|
2016-05-15 18:39:17 +02:00
|
|
|
};
|
2020-07-12 20:27:56 +02:00
|
|
|
|
|
|
|
#endif // LEDEVICEWS2812_H
|