ledstrip.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 * SPDX-FileCopyrightText: 2021-2022 Eike Hein <sho@eikehein.com>
 */
 
#pragma once
 
#include <QColor>
#include <QObject>
#include <QQmlParserStatus>
 
#include <linux/spi/spidev.h>
 
 
#define LED_MAX_BRIGHTNESS 0x1F
 
 
class LedStrip : public QObject, public QQmlParserStatus
{
    Q_OBJECT
    Q_INTERFACES(QQmlParserStatus)
 
    
    Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged)
 
 
    Q_PROPERTY(QString deviceName READ deviceName WRITE setDeviceName NOTIFY deviceNameChanged)
 
 
    Q_PROPERTY(int frequency READ frequency WRITE setFrequency NOTIFY frequencyChanged)
 
 
    Q_PROPERTY(bool connected READ connected NOTIFY connectedChanged)
 
 
    Q_PROPERTY(int count READ count WRITE setCount NOTIFY countChanged)
 
 
    Q_PROPERTY(bool gammaCorrection READ gammaCorrection WRITE setGammaCorrection NOTIFY gammaCorrectionChanged)
 
 
    Q_PROPERTY(qreal gamma READ gamma WRITE setGamma NOTIFY gammaChanged)
 
 
    Q_PROPERTY(bool hsvBrightness READ hsvBrightness WRITE setHsvBrightness NOTIFY hsvBrightnessChanged)
 
 
    Q_PROPERTY(bool canRestore READ canRestore NOTIFY canRestoreChanged)
 
    public:
        enum RestoreOption {
            RestoreColor = 0x1,     
            RestoreBrightness = 0x2 
        };
        Q_DECLARE_FLAGS(RestoreOptions, RestoreOption)
        Q_FLAG(RestoreOptions)
 
        
        explicit LedStrip(QObject *parent = nullptr);
 
 
        explicit LedStrip(int count, QObject *parent = nullptr);
 
 
        ~LedStrip() override;
 
 
        bool enabled() const;
 
 
        void setEnabled(bool enabled);
 
 
        QString deviceName() const;
 
 
        void setDeviceName(const QString &deviceName);
 
 
        int frequency() const;
 
 
        void setFrequency(int frequency);
 
 
        bool connected() const;
 
 
        int count() const;
 
 
        void setCount(int leds);
 
 
        bool gammaCorrection() const;
 
 
        void setGammaCorrection(bool gammaCorrection);
 
 
        qreal gamma() const;
 
 
        void setGamma(qreal gamma);
 
 
        bool hsvBrightness() const;
 
 
        void setHsvBrightness(bool hsvBrightness);
 
 
        Q_INVOKABLE bool setLed(int index, const QColor &color, int brightness);
 
 
        Q_INVOKABLE bool fill(int first, int last, const QColor &color, int brightness = LED_MAX_BRIGHTNESS);
 
 
        Q_INVOKABLE QColor color(int index) const;
 
 
        Q_INVOKABLE QColor colorAverage(int first, int last) const;
 
 
        Q_INVOKABLE bool setColor(int index, const QColor &color);
 
 
        Q_INVOKABLE bool setColor(int first, int last, const QColor &color);
 
 
        Q_INVOKABLE int brightness(int index) const;
 
 
        Q_INVOKABLE int brightnessAverage(int first, int last) const;
 
 
        Q_INVOKABLE bool setBrightness(int index, int brightness);
 
 
        Q_INVOKABLE bool setBrightness(int first, int last, int brightness);
 
 
        Q_INVOKABLE bool reverse();
 
 
        Q_INVOKABLE bool clear();
 
 
        Q_INVOKABLE bool clear(int first, int last);
 
 
        Q_INVOKABLE bool show();
 
 
        Q_INVOKABLE void save();
 
 
        Q_INVOKABLE void forgetSavedData();
 
 
        Q_INVOKABLE bool canRestore() const;
 
 
        Q_INVOKABLE bool restore(RestoreOptions options);
 
        void classBegin() override;
        void componentComplete() override;
 
    Q_SIGNALS:
 
        void enabledChanged() const;
 
 
        void deviceNameChanged();
 
 
        void frequencyChanged() const;
 
 
        void connectedChanged();
 
 
        void countChanged() const;
 
 
        void gammaCorrectionChanged();
 
 
        void gammaChanged();
 
 
        void hsvBrightnessChanged();
 
 
        void canRestoreChanged();
 
    private:
        void connect();
        void disconnect();
        void updateData(int count);
        void updateLut();
        void clearInternal(uint32_t *data, int first, int last);
 
        bool m_enabled;
 
        QString m_deviceName;
        int m_frequency;
        int m_fd;
        bool m_connected;
 
        int m_count;
 
        bool m_gammaCorrection;
        long double m_gamma;
        QByteArray m_lut;
        uint32_t *m_gammaCorrectedData;
 
        bool m_hsvBrightness;
        uint32_t *m_brightnessCorrectedData;
 
        uint8_t *m_header;
        spi_ioc_transfer m_message[3];
        uint8_t *m_footer;
 
        uint32_t *m_data;
        uint32_t *m_savedData;
        int m_savedSize;
 
        bool m_createdByQml;
        bool m_complete;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(LedStrip::RestoreOptions)