hyperion.ng/libsrc/hyperion/LedSpiDevice.h
T. van der Zwan 518ca910b7 Implemented the Ldp6803 device.
Former-commit-id: e38f7d697fbf137d89bfefb1503848a771f51dad
2013-11-02 05:51:41 +00:00

60 lines
1.5 KiB
C++

#pragma once
// Linux-SPI includes
#include <linux/spi/spidev.h>
// Hyperion includes
#include <hyperion/LedDevice.h>
///
/// The LedSpiDevice implements an abstract base-class for LedDevices using the SPI-device.
///
class LedSpiDevice : public LedDevice
{
public:
///
/// Constructs the LedDevice attached to a SPI-device
///
/// @param[in] outputDevice The name of the output device (eg '/etc/SpiDev.0.0')
/// @param[in] baudrate The used baudrate for writing to the output device
///
LedSpiDevice(const std::string& outputDevice, const unsigned baudrate);
///
/// Destructor of the LedDevice; closes the output device if it is open
///
virtual ~LedSpiDevice();
///
/// Opens and configures the output device
///
/// @return Zero on succes else negative
///
int open();
protected:
/**
* Writes the given bytes/bits to the SPI-device and sleeps the latch time to ensure that the
* values are latched.
*
* @param[in[ len The length of the data
* @param[in] vec The data
* @param[in] latchTime_ns The latch-time to latch in the values across the SPI-device (negative
* means no latch required) [ns]
*
* @return Zero on succes else negative
*/
int latch(const unsigned len, const char * vec, const int latchTime_ns);
private:
/// The name of the output device
const std::string mDeviceName;
/// The used baudrate of the output device
const int mBaudRate_Hz;
/// The File Identifier of the opened output device (or -1 if not opened)
int mFid;
/// The transfer structure for writing to the spi-device
spi_ioc_transfer spi;
};