frodovdr/hyperion.ng
1
0
Fork 0
mirror of https://github.com/hyperion-project/hyperion.ng.git synced 2025-03-01 10:33:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Support SK9822 type LEDs with adaptive brightness control via SPI (#1017)

Browse Source 
* Support SK9822 type LEDs with adaptive brightness control via SPI

* SK9822 - minor refactorings
This commit is contained in:
The-Master777
2020-09-25 19:34:00 +02:00
committed by GitHub
parent f11885fd8b
commit 6c68454bea
9 changed files with 298 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
libsrc/leddevice/dev_spi/LedDeviceSK9822.h Normal file
View File

@@ -0,0 +1,83 @@
#ifndef LEDEVICESK9822_H
#define LEDEVICESK9822_H
// hyperion includes
#include "ProviderSpi.h"
///
/// Implementation of the LedDevice interface for writing to SK9822 led device via SPI.
///
class LedDeviceSK9822 : public ProviderSpi
{
public:
///
/// @brief Constructs an SK9822 LED-device
///
/// @param deviceConfig Device's configuration as JSON-Object
///
explicit LedDeviceSK9822(const QJsonObject &deviceConfig);
///
/// @brief Constructs the LED-device
///
/// @param[in] deviceConfig Device's configuration as JSON-Object
/// @return LedDevice constructed
///
static LedDevice* construct(const QJsonObject &deviceConfig);
private:
///
/// @brief Writes the RGB-Color values to the SPI Tx buffer setting SK9822 current level to maximal value.
///
/// @param[in,out] txBuf The packed spi transfer buffer of the LED's color values
/// @param[in] ledValues The RGB-color per LED
/// @param[in] maxLevel The maximal current level 1 .. 31 to use
///
void bufferWithMaxCurrent(std::vector<uint8_t> &txBuf, const std::vector<ColorRgb> & ledValues, const int maxLevel);
///
/// @brief Writes the RGB-Color values to the SPI Tx buffer using an adjusted SK9822 current level for LED maximal rgb-grayscale values not exceeding the threshold, uses maximal level otherwise.
///
/// @param[in,out] txBuf The packed spi transfer buffer of the LED's color values
/// @param[in] ledValues The RGB-color per LED
/// @param[in] threshold The threshold 0 .. 255 that defines whether to use adjusted SK9822 current level per LED
/// @param[in] maxLevel The maximal current level 1 .. 31 to use
///
void bufferWithAdjustedCurrent(std::vector<uint8_t> &txBuf, const std::vector<ColorRgb> & ledValues, const int threshold, const int maxLevel);
/// The threshold that defines use of SK9822 global brightness control for maximal rgb grayscale values below.
/// i.e. global brightness control is used for rgb-values when max(r,g,b) < threshold.
int _globalBrightnessControlThreshold;
/// The maximal current level that is targeted. Possibile values 1 .. 31.
int _globalBrightnessControlMaxLevel;
///
/// @brief Scales the given value such that a given grayscale stimulus is reached for the targeted brightness and defined max current value.
///
/// @param[in] value The grayscale value to scale
/// @param[in] maxLevel The maximal current level 1 .. 31 to use
/// @param[in] brightness The target brightness
/// @return The scaled grayscale stimulus
///
inline __attribute__((always_inline)) unsigned scale(const uint8_t value, const int maxLevel, const uint16_t brightness);
///
/// @brief Initialise the device's configuration
///
/// @param[in] deviceConfig the JSON device configuration
/// @return True, if success
///
bool init(const QJsonObject &deviceConfig) override;
///
/// @brief Writes the RGB-Color values to the LEDs.
///
/// @param[in] ledValues The RGB-color per LED
/// @return Zero on success, else negative
///
int write(const std::vector<ColorRgb> & ledValues) override;
};
#endif // LEDEVICESK9822_H