cfgbus_led.h

Go to the documentation of this file.

// Copyright 2021-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/cfgbus_core.h>
#include <satcat5/list.h>
#include <satcat5/polling.h>
 
namespace satcat5 {
    namespace cfg {
        class LedArray {
        public:
            LedArray(satcat5::cfg::ConfigBus* cfg,
                unsigned devaddr, unsigned count);
 
            unsigned count() const {return m_count;}
 
            u8 get(unsigned idx);
            void set(unsigned idx, u8 brt);
 
        protected:
            satcat5::cfg::Register m_reg;   
            const unsigned m_count;         
        };
 
        class LedActivity {
        public:
            LedActivity(satcat5::cfg::ConfigBus* cfg,
                unsigned devaddr, unsigned regaddr,
                unsigned stats_idx, u8 brt = 128);
 
            void update(satcat5::cfg::NetworkStats* stats);
 
        private:
            friend satcat5::util::ListCore;
            satcat5::cfg::Register m_reg;   // Base control register
            const unsigned m_stats_idx;     // NetworkStats index
            const u8 m_brt;                 // Max LED brightness
            u8 m_state;                     // Recent activity state
            LedActivity* m_next;            // Linked list of other LEDs
        };
 
        class LedActivityCtrl : public satcat5::poll::Timer {
        public:
            explicit LedActivityCtrl(
                satcat5::cfg::NetworkStats* stats,
                unsigned delay_msec = 33);  // Default speed = 30 fps
 
            inline void add(LedActivity* led) {m_list.add(led);}
 
        private:
            void timer_event() override;    // Timer event handler
 
            satcat5::cfg::NetworkStats* const m_stats;
            satcat5::util::List<LedActivity> m_list;
        };
 
        class LedWave {
        public:
            LedWave(satcat5::cfg::ConfigBus* cfg,
                unsigned devaddr, unsigned regaddr, u8 m_brt = 128);
 
            void update(u32 incr);
 
        private:
            friend satcat5::util::ListCore;
            satcat5::cfg::Register m_reg;   // Base control register
            const u8 m_brt;                 // Max LED brightness
            u32 m_phase;                    // Animation phase counter
            LedWave* m_next;                // Linked list of other LEDs
        };
 
        class LedWaveCtrl : public satcat5::poll::Timer {
        public:
            LedWaveCtrl();
 
            inline void add(LedWave* led) {m_list.add(led);}
 
            void start(unsigned delay=20);  
            void stop();                    
 
        private:
            void timer_event() override;    // Timer event handler
 
            satcat5::util::List<LedWave> m_list;
            u32 m_incr;                     // Animation speed
        };
    }
}