frodovdr/hyperion.ng
1
0
Fork 0
mirror of https://github.com/hyperion-project/hyperion.ng.git synced 2023-10-10 13:36:59 +02:00
Code Issues Releases Wiki Activity

Added comments to the LedDeviceWs2812b

Browse Source 
Former-commit-id: 4314edf59a776f2424d0066c14ba41c7b3162842
This commit is contained in:
T. van der Zwan 2013-12-25 15:37:59 +00:00
parent 4a494e53e9
commit eaa4b0bae5
2 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
libsrc/leddevice/LedDeviceWs2812b.cpp
View File

@ -61,6 +61,8 @@ LedDeviceWs2812b::ByteSignal LedDeviceWs2812b::byte2Signal(const uint8_t byte) c
uint8_t LedDeviceWs2812b::bits2Signal(const bool bit1, const bool bit2) const uint8_t LedDeviceWs2812b::bits2Signal(const bool bit1, const bool bit2) const
{ {
// See https://github.com/tvdzwan/hyperion/wiki/Ws2812b for the explanation of the given
// translations
if (bit1) if (bit1)
{ {
if (bit2) if (bit2)

42
libsrc/leddevice/LedDeviceWs2812b.h
View File

@ -4,17 +4,38 @@
// Hyperion leddevice includes // Hyperion leddevice includes
#include "LedRs232Device.h" #include "LedRs232Device.h"
///
/// The LedDevice for controlling a string of WS2812B leds. These are controlled over the mini-UART
/// of the RPi (/dev/ttyAMA0).
///
class LedDeviceWs2812b : public LedRs232Device class LedDeviceWs2812b : public LedRs232Device
{ {
public: public:
///
/// Constructs the device (all required parameters are hardcoded)
///
LedDeviceWs2812b(); LedDeviceWs2812b();
///
/// Write the color data the the WS2812B led string
///
/// @param ledValues The color data
/// @return Zero on succes else negative
///
virtual int write(const std::vector<ColorRgb> & ledValues); virtual int write(const std::vector<ColorRgb> & ledValues);
///
/// Write zero to all leds(that have been written by a previous write operation)
///
/// @return Zero on succes else negative
///
virtual int switchOff(); virtual int switchOff();
private: private:
///
/// Structure holding the four output-bytes corresponding to a single input byte
///
struct ByteSignal struct ByteSignal
{ {
uint8_t bit_12; uint8_t bit_12;
@ -22,13 +43,34 @@ private:
uint8_t bit_56; uint8_t bit_56;
uint8_t bit_78; uint8_t bit_78;
}; };
/// Translation table from single input-byte to output-bytes
std::vector<ByteSignal> _byte2signalTable; std::vector<ByteSignal> _byte2signalTable;
///
/// Fills the translation table (_byte2signalTable)
///
void fillTable(); void fillTable();
///
/// Computes the output bytes that belong to a given input-byte (no table lookup)
///
/// @param byte The input byte
/// @return The four bytes (ByteSignal) for the output signal
///
ByteSignal byte2Signal(const uint8_t byte) const; ByteSignal byte2Signal(const uint8_t byte) const;
///
/// Translates two bits to a single byte
///
/// @param bit1 The value of the first bit (1=true, zero=false)
/// @param bit1 The value of the ssecond bit (1=true, zero=false)
///
/// @return The output-byte for the given two bit
///
uint8_t bits2Signal(const bool bit1, const bool bit2) const; uint8_t bits2Signal(const bool bit1, const bool bit2) const;
///
/// The output buffer for writing bytes to the output
///
std::vector<ByteSignal> _ledBuffer; std::vector<ByteSignal> _ledBuffer;
}; };