TwinkleOffAnimation.h

Go to the documentation of this file.

/* Copyright (C) Cross The Road Electronics 2024 */
#pragma once
 
#include "ctre/phoenix/led/BaseTwoSizeAnimation.h"
 
namespace ctre {namespace phoenix {namespace led {
 
/**
 * Animation that randomly turns on LEDs, until it reaches the maximum count and turns them all off
 *
 * @deprecated This device's Phoenix 5 API is deprecated for removal in the
 * 2027 season. Users should update to Phoenix 6 firmware and migrate to the
 * Phoenix 6 API. A migration guide is available at
 * https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.
 *
 * If the Phoenix 5 API must be used for this device, the device must have 22.X
 * firmware. This firmware is available in Tuner X after selecting Phoenix 5 in
 * the firmware year dropdown.
 */
class [[deprecated("This device's Phoenix 5 API is deprecated for removal in the 2027 season."
                "Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API."
                "A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html")]]
TwinkleOffAnimation : public BaseTwoSizeAnimation {
public:
    /**
     * The maximum percentage of LEDs that are allowed to turn on
     */
    enum TwinkleOffPercent {
        /**
         * All the LEDs are allowed to turn on
         */
        Percent100 = 0,
        /**
         * 88% of LEDs are allowed to turn on
         */
        Percent88 = 1,
        /**
         * 76% of LEDs are allowed to turn on
         */
        Percent76 = 2,
        /**
         * 64% of LEDs are allowed to turn on
         */
        Percent64 = 3,
        /**
         * 42% of LEDs are allowed to turn on
         */
        Percent42 = 4,
        /**
         * 30% of LEDs are allowed to turn on
         */
        Percent30 = 5,
        /**
         * 18% of LEDs are allowed to turn on
         */
        Percent18 = 6,
        /**
         * 6% of LEDs are allowed to turn on
         */
        Percent6 = 7,
    };
 
    /**
     * Constructor for a TwinkleAnimation
     * @param r How much red should the color have [0, 255]
     * @param g How much green should the color have [0, 255]
     * @param b How much blue should the color have [0, 255]
     * @param w How much white should the color have [0, 255]
     * @param speed How fast should the color travel the strip [0, 1]
     * @param numLed How many LEDs the CANdle controls
     * @param divider What percentage of LEDs can be on at any point
     * @param ledOffset Where to start the animation
     */
    TwinkleOffAnimation(int r, int g, int b, int w = 0, double speed = 1, int numLed = -1, TwinkleOffPercent divider = TwinkleOffPercent::Percent100, int ledOffset = 0);
    /**
     * Sets the percentage of LEDs that are allowed on
     * @param divider The percentage of LEDs that are allowed on at any point
     */
    void SetDivider(TwinkleOffPercent divider);
};
 
} // namespace led
} // namespace phoenix
} // namespace ctre