library_identity.hpp

Go to the documentation of this file.

/**
 * @file library_identity.hpp
 * @brief Sound Byte Libs identity and constants
 * @ingroup common
 * 
 * Central location for library-wide constants and identity information.
 */
 
#ifndef SBL_COMMON_LIBRARY_IDENTITY_HPP_
#define SBL_COMMON_LIBRARY_IDENTITY_HPP_
 
namespace sbl {
namespace common {
 
/**
 * @brief Library identity constants
 */
struct LibraryIdentity {
    static constexpr const char* NAME = "Sound Byte Libs";
    static constexpr const char* VENDOR = "Sound Byte Labs";
    static constexpr const char* LICENSE = "Copyright (c) 2025 Michael Skiles";
};
 
/**
 * @brief ARM Cortex-M hardware constants
 * 
 * These constants define ARM Cortex-M specific limitations that the
 * library is designed around.
 */
struct ArmConstants {
    /// Maximum pins per GPIO port (ARM Cortex-M standard)
    static constexpr uint32_t MAX_GPIO_PINS_PER_PORT = 32;
    
    /// Typical interrupt priority levels (0 = highest)
    static constexpr uint32_t INTERRUPT_PRIORITY_HIGHEST = 0;
    static constexpr uint32_t INTERRUPT_PRIORITY_HIGH = 2;
    static constexpr uint32_t INTERRUPT_PRIORITY_NORMAL = 4;
    static constexpr uint32_t INTERRUPT_PRIORITY_LOW = 6;
    static constexpr uint32_t INTERRUPT_PRIORITY_LOWEST = 7;
};
 
/**
 * @brief Default timing constants
 * 
 * Common timing values used throughout the library.
 */
struct TimingConstants {
    /// Default debounce time for buttons (milliseconds)
    static constexpr uint32_t DEFAULT_DEBOUNCE_MS = 50;
    
    /// Default blink interval (milliseconds)
    static constexpr uint32_t DEFAULT_BLINK_INTERVAL_MS = 500;
    
    /// Microseconds per millisecond
    static constexpr uint32_t MICROS_PER_MILLI = 1000;
    
    /// Milliseconds per second
    static constexpr uint32_t MILLIS_PER_SECOND = 1000;
};
 
} // namespace common
} // namespace sbl
 
#endif // SBL_COMMON_LIBRARY_IDENTITY_HPP_