ws2812_cpp.hpp

Go to the documentation of this file.

 
#pragma once
#include "rmt_wrapper.hpp"
#include "ws2812_control.h"
#include "ws2812_version.h"
#include <cstdint>
#include <vector>
 
#ifdef __cplusplus
 
enum class LedType { RGB, RGBW };
 
class WS2812Strip {
public:
  explicit WS2812Strip(gpio_num_t gpio = (gpio_num_t)CONFIG_WS2812_LED_RMT_TX_GPIO,
                       int channel = CONFIG_WS2812_LED_RMT_TX_CHANNEL, uint32_t num_leds = NUM_LEDS,
#if CONFIG_WS2812_LED_TYPE_RGBW
                       LedType type = LedType::RGBW,
#else
                       LedType type = LedType::RGB,
#endif
                       uint16_t t0h = WS2812_T0H, uint16_t t1h = WS2812_T1H,
                       uint16_t t0l = WS2812_T0L, uint16_t t1l = WS2812_T1L,
                       uint8_t brightness = WS2812_DEFAULT_BRIGHTNESS);
 
  esp_err_t Begin();
 
  void SetPixel(uint32_t index, uint32_t rgbw);
 
  uint32_t Length() const;
 
  esp_err_t Show();
 
  void SetBrightness(uint8_t value);
 
  void SetNumLeds(uint32_t num_leds);
 
  void SetTimings(uint16_t t0h, uint16_t t1h, uint16_t t0l, uint16_t t1l);
 
  static uint32_t ColorWheel(uint8_t pos);
 
  static constexpr uint32_t kResetTimeUs = 300;
 
  // ===========================================================================
  // Driver Version
  // ===========================================================================
 
  static constexpr const char* GetDriverVersion() noexcept {
    return HF_WS2812_RMT_VERSION_STRING;
  }
 
  static constexpr uint8_t GetDriverVersionMajor() noexcept {
    return HF_WS2812_RMT_VERSION_MAJOR;
  }
 
  static constexpr uint8_t GetDriverVersionMinor() noexcept {
    return HF_WS2812_RMT_VERSION_MINOR;
  }
 
  static constexpr uint8_t GetDriverVersionPatch() noexcept {
    return HF_WS2812_RMT_VERSION_PATCH;
  }
 
private:
  static constexpr uint16_t kResetTicks = kResetTimeUs * 10; // 100 ns ticks
 
  std::vector<uint32_t> pixels_;
  std::vector<rmt_symbol_word_t> buffer_;
  ws2812::RmtTx rmt_;
  gpio_num_t gpio_;
  int channel_;
  LedType type_;
  uint16_t t0h_;
  uint16_t t1h_;
  uint16_t t0l_;
  uint16_t t1l_;
  uint8_t brightness_;
  uint32_t num_leds_;
};
 
inline const char* GetWS2812DriverVersion() noexcept {
  return HF_WS2812_RMT_VERSION_STRING;
}
 
#endif // __cplusplus