hyperion.ng
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ProviderSpi Class Reference

The ProviderSpi implements an abstract base-class for LedDevices using the SPI-device. More...

#include <ProviderSpi.h>

Inheritance diagram for ProviderSpi:
LedDevice LedDeviceAPA102 LedDeviceAPA104 LedDeviceLpd6803 LedDeviceLpd8806 LedDeviceP9813 LedDeviceSk6812SPI LedDeviceSk6822SPI LedDeviceWs2801 LedDeviceWs2812SPI

Public Member Functions

 ProviderSpi ()
 Constructs specific LedDevice.
 
virtual bool init (const QJsonObject &deviceConfig)
 Sets configuration. More...
 
virtual ~ProviderSpi ()
 Destructor of the LedDevice; closes the output device if it is open.
 
int open ()
 Opens and configures the output device. More...
 
- Public Member Functions inherited from LedDevice
 LedDevice (const QJsonObject &config=QJsonObject(), QObject *parent=nullptr)
 
virtual int switchOff ()
 Switch the leds off (led hardware disable)
 
virtual int switchOn ()
 Switch the leds on (led hardware enable), used if reinitialization is required for the device implementation.
 
virtual int setLedValues (const std::vector< ColorRgb > &ledValues)
 
const QString & getColorOrder ()
 Get color order of device. More...
 
void setActiveDevice (QString dev)
 
const QString & getActiveDevice ()
 
void setLedCount (int ledCount)
 
int getLedCount ()
 
void setEnable (bool enable)
 
bool enabled ()
 
int getLatchTime ()
 
bool componentState ()
 
virtual int write (const std::vector< ColorRgb > &ledValues)=0
 Writes the RGB-Color values to the leds. More...
 

Protected Member Functions

int writeBytes (const unsigned size, const uint8_t *data)
 Writes the given bytes/bits to the SPI-device and sleeps the latch time to ensure that the values are latched. More...
 

Protected Attributes

QString _deviceName
 The name of the output device.
 
int _baudRate_Hz
 The used baudrate of the output device.
 
int _fid
 The File Identifier of the opened output device (or -1 if not opened)
 
int _spiMode
 which spi clock mode do we use? (0..3)
 
bool _spiDataInvert
 1=>invert the data pattern
 
spi_ioc_transfer _spi
 The transfer structure for writing to the spi-device.
 
- Protected Attributes inherited from LedDevice
QJsonObject _devConfig
 
Logger_log
 The common Logger instance for all LedDevices.
 
std::vector< uint8_t > _ledBuffer
 The buffer containing the packed RGB values.
 
bool _deviceReady
 
QString _activeDevice
 
int _ledCount
 
int _ledRGBCount
 
int _ledRGBWCount
 
QTimer _refresh_timer
 Timer object which makes sure that led data is written at a minimum rate e.g. More...
 
unsigned int _refresh_timer_interval
 
qint64 _last_write_time
 
unsigned int _latchTime_ms
 

Additional Inherited Members

- Public Slots inherited from LedDevice
virtual void start ()
 Is called on thread start, all construction tasks and init should run here.
 
- Signals inherited from LedDevice
void enableStateChanged (bool newState)
 Emits whenever the led device switches between on/off. More...
 
void visiblePriorityChanged (const quint8 &priority)
 PIPER signal for Priority Muxer -> LedDevice. More...
 
- Protected Slots inherited from LedDevice
int rewriteLeds ()
 Write the last data to the leds again.
 

Detailed Description

The ProviderSpi implements an abstract base-class for LedDevices using the SPI-device.

Member Function Documentation

§ init()

bool ProviderSpi::init ( const QJsonObject &  deviceConfig)
virtual

Sets configuration.

Parameters
deviceConfigthe json device config
Returns
true if success

Reimplemented from LedDevice.

Reimplemented in LedDeviceLpd8806, LedDeviceLpd6803, LedDeviceAPA104, LedDeviceSk6812SPI, LedDeviceSk6822SPI, LedDeviceWs2812SPI, LedDeviceP9813, and LedDeviceAPA102.

§ open()

int ProviderSpi::open ( )
virtual

Opens and configures the output device.

Returns
Zero on succes else negative

Reimplemented from LedDevice.

§ writeBytes()

int ProviderSpi::writeBytes ( const unsigned  size,
const uint8_t *  data 
)
protected

Writes the given bytes/bits to the SPI-device and sleeps the latch time to ensure that the values are latched.

Parameters

The documentation for this class was generated from the following files: