The ProviderHID implements an abstract base-class for LedDevices using an HID-device. More...

Inheritance diagram for ProviderHID:

Public Member Functions
	ProviderHID ()
	Constructs specific LedDevice.

virtual	~ProviderHID ()
	Destructor of the LedDevice; closes the output device if it is open.

virtual bool	init (const QJsonObject &deviceConfig)
	Sets configuration. More...

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 to the HID-device and. More...

Protected Attributes
unsigned short	_VendorId

unsigned short	_ProductId

bool	_useFeature

hid_device *	_deviceHandle
	libusb device handle

int	_delayAfterConnect_ms
	Sleep after the connect before continuing.

bool	_blockedForDelay

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 ProviderHID implements an abstract base-class for LedDevices using an HID-device.

Member Function Documentation

bool ProviderHID::init ( const QJsonObject & deviceConfig )

virtual

Sets configuration.

Parameters

deviceConfig the json device config

Reimplemented from LedDevice.

int ProviderHID::open ( )

virtual

Opens and configures the output device.

Reimplemented from LedDevice.

protected

Writes the given bytes to the HID-device and.

Parameters

[in]	size	The length of the data
[in]	data	The data

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